A short description of the project.

MIT

Before committing your changes, perform next steps (in same order):

1. test your code:

   docker-compose run --rm app test

2. lint your code:

   docker-compose run --rm app lint

3. perform python imports sort:

   docker-compose run --rm app sort

4. format your code:

   docker-compose run --rm app format

Or you can just run:

docker-compose run --rm app runtest

which will do all that stuff for you. Note, this command will only output a diff of suggested formatting changes (if any exist). Changes will not be applied automatically.

If you want to use in your project pre-commit hooks, type in your project root:

bin/install-git-hooks.sh

From now on, after you type git commit command, the pre-commit hooks will be executed first, checking or reformatting your code (depending on which hooks you are using), also commit won't succeed without all hooks passing.

Hooks scripts are localized in git-hooks directory in the root of the project. You can easily expand it with your own hooks by adding new .sh files into this folder.

Note, to skip git hooks, add --no-verify or -n option. For example git commit -n -m "your commit message".

On Linux, Docker runs as a system daemon with root privileges, and can actively create files inaccessible to the host user. If you'd like to avoid that, you'll need to create an .env file with your UID - the containers started by docker-compose will create files owned by this UID. Run

echo "UID=${UID}" > .env

to do so.

Your Linux user won't have permission to use docker by default. This can be fixed by adding them to the docker group, as explained in the official docs.

Running docker and compose commands with sudo will break the setup in this template and re-introduce file permission problems we've worked hard to avoid. Please don't.

This project uses Pipenv for dependency management. Pipenv generates a lockfile containing pinned dependencies, and dependencies are installed based on said lockfile, which should be added to source control and updated manually when needed.

Pipenv's dependency specification lives in a Pipfile. Please note that Pipenv stores both base and dev dependencies in the same file, and take care to add your custom dependencies to the right section.

After you first build the project, you need to run

docker-compose run --rm app lock-dependencies

and add the backend/Pipfile.lock file it creates to git.

This procedure should be repeated every time you modify the Pipfile, or when you'd like to update the pinned versions of your dependencies while keeping them within the spec.

• 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 an superuser account, use this command:

docker-compose run --rm app ./manage.py 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.

To run the tests, check your test coverage, and generate an HTML coverage report::

docker-compose run --rm app pytest --cov-report html --cov . --verbose
open backend/htmlcov/index.html

docker-compose run --rm app pytest .

This app comes with Celery. By default all tasks is run not async. If you need work local with async you must change CELERY_ALWAYS_EAGER on False in backend/settings/local.py then all tasks will use redis and docker configurations.

CELERY_ALWAYS_EAGER = False

Sentry is an error logging aggregator service. You can send email to DevOps team and asking about you account and project build_migration.

You must set the DSN url in production.

Graphene is a library for GraphQL API implementation. All the requests to GraphQL server are handled by a single URL and Graphene's GraphQLView view. The view has a parameter to enable a web-based integrated development environment, GraphiQL (graphiql=True). If you set the GraphQL endpoint behind an authorization feature like a token, this tool becomes inconvenient to use because of the need to modify the headers which is not implemented in GraphiQL. A solution to this is to prepare a separate, development-only endpoint with GraphiQL enabled and not requiring authentication.

The following details how to deploy this application.