QueryJane | Development Update

Repository
https://github.com/roadhousestudio/queryjane_app

QueryJane is a web application developed with Django that allows to connect with companies and experts in different sectors of the cannabis industry. Beta version is available here.

New Features

I have been working in a new flow to manage the legal pages: User agreement and privacy policy.

Before, this information was written in flat pages, and the only way to update it was editing the html files directly. Now, users with administration permissions in the platform can update the information in pages like user agreement, privacy policy and cookies policy.

When a platform administrator user visits a page like the user agreement, the button Edit will be available:

When an administrator user clicks this button, the page content switches to a form with the following fields:

• English description.
• Spanish description.
• notify users.

The application is available in English and in Spanish, for this reason, there are available two text fields. Administrator users can update the information and fix some bugs, make redaction improvements, etc. If the change is not important, administrator users should not check the field called Notify users.

The Notify users field must be checked only if the change is an important change. Why?

If the Notify users field is checked, the application will create a notification for all users. This notification will be available in the main notifications section in the header bar:

Also, the user model has two attributes: accepted_terms and accepted_privacy_policy. These are boolean fields. If the "Notify users" field is checked, and if the administrator user has edited the user agreement, the accepted_terms will be changed to False. In the same way, if the administrator user has edited the privacy policy, the accepted_privacy_policy attribute will be changed to False. It means, that user has not accepted the new user agreement or the new privacy policy.

When a user authenticates in the application, and he has not accepted the new user agreement, he will be notified:

In the same way with the privacy policy:

These messages will be displayed in all application pages. To hide them, user must accept the new user agreement and the new privacy policy.

User can accept new privacy policy or the new agreement following the link displayed in the messages above, or following the new notification available en the header bar.

If user click the link "Check it out" displayed in the images above, he will be redirected to the user agreement or the privacy policy page. At the end of these pages, will be available the button "I'm agree":

By clicking this button, the user will accept the document changes.

If user clicks the notification in the header bar, the new content of the user agreement or of the privacy policy will be displayed in the notifications modal:

The "I'm agree" button will be available at the modal footer.

Code changes related to this new features can be found in this PULL REQUEST.

---

I have also taken the opportunity to work on cleaning the project migrations. Each time that a change is make in the models (the database columns), Django creates a migration file. This project is really big, then, we have more than 30 migrations in some applications, and it is not necessary now. Then, we can clean these files following the next steps:

• 1. Create a database backup.

The database engine used in this project is Postgres. Create a backup of your database by running the following command:

Using virtualenv:

pg_dump -U <database user> -h localhost <database name> -f <backup.sql>

Using Docker:

docker exec -t queryjaneapp_db_1 pg_dumpall -c -U postgres > dump_sql

This step is only for security, if there is some bug, we want to have a db backup.

• 2. Remove all files from migration folder, except the __init__.py file.

• 3. Generate new migrations by running the following command.

Using virtualenv:

./manage.py makemigrations

using Docker:

docker-compose exec web python manage.py makemigrations

• 4. Run migration using the --fake option.

Using virtualenv:

./manage.py migrate --fake

using Docker:

docker-compose exec web python manage.py migrate --fake

In this way, we will mark the new migrations as executed, but our db structure will not be changed.

In this pull request we can find a lot of removed migration files.

GitHub Account

https://github.com/aaquirogal

PR1
PR2

---

---

How to contribute

QueryJane has been developed using the Django framework. You can fork the project, and run it locally is very easy. Follow the steps described in the open source repository installation guide. The project has been configured using Docker. you only need to install Docker and follow these steps.

Future work.

Take a look to our public trello board. This is the easiest way to know our roadmap.

If you want to contribute, please join my Discord.

---