hasol

House cleaning rota software.

Development

This is a Django codebase. Check out the Django docs for general technical documentation.

Structure

The Django project is hasol. There is one Django app, main Django app, with all business logic.

Dependencies

Create virtualenv, enable it and then install requirements:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Note: This project uses pip-tools for dependencies management.

Environment variables

You need to create a new file named .env in the root of this project once you cloned it.

.env should contain the following env variables:

SECRET_KEY="thisisthesecretkey"
DATABASE_URL="postgres://postgres:[email protected]:5432/postgres"
EMAIL_HOST_USER="smtp_user"
EMAIL_HOST_PASSWORD="smtp_password"

For production use also add:

NODEBUG=1

Database

This project uses PostgreSQL. See above on how to configure it using the .env file.

After creating your local database, you need to apply the migrations:

python manage.py migrate

Serve

Finally, you can run the Django development server:

python manage.py runserver

Or, run the production-grade uwsgi server:

uwsgi --ini=uwsgi.ini

Note: The uwsgi method does not read the .env file, so in this case you need to set the env vars in your shell.

Code linting & formatting

black . && isort -y && flake8