Skip to content

Getting Started

Settings

Moved to settings.

Basic Commands

Running locally with Docker

Open a terminal at the project root and run the following for local development:

1
make up

The web application is accessible at http://localhost:8000.

For the first time you will need to run migrations with:

1
make dev.migrate

Optionally, You can also set the environment variable COMPOSE_FILE pointing to local.yml like this:

1
export COMPOSE_FILE=local.yml

Please see cookiecutter-django docs for more information about running locally with Docker.

Setting Up Your Users

  • To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
  • To create a superuser account, use this command:
1
make dev.manage.createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

1
make dev.test.quality

Running unit tests with pytest

1
make test.unit

Generate coverage report in HTML

After running unit tests, you can generate an HTML coverage report:

1
make dev.cov.html

The results will be available in the htmlcov/index.html. You can open it with your browser.

Celery

This app comes with Celery. To run a celery worker, use:

1
docker-compose -f local.yml run django celery -A config.celery_app worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

Deployment

The following details how to deploy this application.

Docker

See detailed cookiecutter-django Docker documentation .

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.