cookiecutter-django/{{cookiecutter.project_slug}}
2022-06-06 00:09:46 +01:00
..
.envs Fix pre-commit hook issues with Docker & Celery 2021-04-07 20:57:04 +01:00
.github Unify compressor, gulp and custom bootstrap options (#3535) 2022-03-20 15:00:40 +00:00
.idea Unify compressor, gulp and custom bootstrap options (#3535) 2022-03-20 15:00:40 +00:00
{{cookiecutter.project_slug}} Fix type error 2022-06-04 14:49:26 -03:00
bin Fix issue with Heroku + Django Compressor 2020-07-04 15:20:51 +01:00
compose Unify compressor, gulp and custom bootstrap options (#3535) 2022-03-20 15:00:40 +00:00
config Update domain for Celery docs (#3663) 2022-04-01 17:32:05 +01:00
docs Fix a few typos in the documentation (#3625) 2022-03-09 16:25:00 +00:00
locale Move to the python:alpine docker image (#1482) 2018-02-22 10:01:05 -05:00
requirements Update whitenoise from 6.1.0 to 6.2.0 (#3737) 2022-06-06 00:09:46 +01:00
utility Added Debian 11 (Bullseye) OS dependencies (duplicated from buster) 2021-10-26 13:58:18 +02:00
.dockerignore Add venv to .dockerignore 2021-06-19 01:18:31 -03:00
.editorconfig Add a PyCharm run configuration for docker-compose (#3462) 2021-12-20 09:39:23 +00:00
.gitattributes Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.gitignore Unify compressor, gulp and custom bootstrap options (#3535) 2022-03-20 15:00:40 +00:00
.gitlab-ci.yml Fix GitLab CI error caused by Docker Compose's platform option (#3585) 2022-02-10 15:06:22 +00:00
.pre-commit-config.yaml Add pyupgrade to pre-commit config (#3702) 2022-05-07 19:21:15 +01:00
.pylintrc Add django-settings-module to .pylintrc 2021-09-24 13:19:08 +05:30
.readthedocs.yml Add back version number but use testing image 2021-08-12 16:31:35 -04:00
.travis.yml Update from Python3.8 to Python3.9 2021-01-26 16:13:27 +01:00
CONTRIBUTORS.txt Revert "Added name to CONTRIBUTORS.txt" 2020-08-11 16:05:14 +01:00
COPYING Add GPLv3 licence support 2016-06-24 16:59:55 +02:00
gulpfile.js Unify compressor, gulp and custom bootstrap options (#3535) 2022-03-20 15:00:40 +00:00
LICENSE Fix pre-commit hook issues 2021-04-07 20:57:04 +01:00
local.yml Unify compressor, gulp and custom bootstrap options (#3535) 2022-03-20 15:00:40 +00:00
manage.py Handle path with pathlib 2019-07-10 20:35:38 +02:00
merge_production_dotenvs_in_dotenv.py Add pyupgrade to pre-commit config (#3702) 2022-05-07 19:21:15 +01:00
package.json Configure Dependabot for npm packages at the template level (#3436) 2021-12-07 19:05:59 +00:00
Procfile Fix pre-commit config (#3435) 2021-11-29 11:16:05 +00:00
production.yml Fix docker-compose config on Apple silicon (#3562) 2022-02-07 18:23:55 +00:00
pytest.ini Unify compressor, gulp and custom bootstrap options (#3535) 2022-03-20 15:00:40 +00:00
README.md Unify compressor, gulp and custom bootstrap options (#3535) 2022-03-20 15:00:40 +00:00
requirements.txt Simplify post hook 2018-03-04 14:43:54 +03:00
runtime.txt Bump Python runtime for Heroku 2021-11-16 19:47:39 +00:00
setup.cfg Add djangorestframework-stubs 2021-10-11 20:41:32 -05:00

{{cookiecutter.project_name}}

{{ cookiecutter.description }}

Built with Cookiecutter Django Black code style

{%- if cookiecutter.open_source_license != "Not open source" %}

License: {{cookiecutter.open_source_license}} {%- endif %}

Settings

Moved to settings.

Basic Commands

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:

    $ python 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.

Type checks

Running type checks with mypy:

$ mypy {{cookiecutter.project_slug}}

Test coverage

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

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

{%- if cookiecutter.use_celery == "y" %}

Celery

This app comes with Celery.

To run a celery worker:

cd {{cookiecutter.project_slug}}
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.

{%- endif %} {%- if cookiecutter.use_mailhog == "y" %}

Email Server

{%- if cookiecutter.use_docker == "y" %}

In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server MailHog with a web interface is available as docker container.

Container mailhog will start automatically when you will run all docker containers. Please check cookiecutter-django Docker documentation for more details how to start all containers.

With MailHog running, to view messages that are sent by your application, open your browser and go to http://127.0.0.1:8025 {%- else %}

In development, it is often nice to be able to see emails that are being sent from your application. If you choose to use MailHog when generating the project a local SMTP server with a web interface will be available.

  1. Download the latest MailHog release for your OS.

  2. Rename the build to MailHog.

  3. Copy the file to the project root.

  4. Make it executable:

    $ chmod +x MailHog
    
  5. Spin up another terminal window and start it there:

    ./MailHog
    
  6. Check out http://127.0.0.1:8025/ to see how it goes.

Now you have your own mail server running locally, ready to receive whatever you send it.

{%- endif %}

{%- endif %} {%- if cookiecutter.use_sentry == "y" %}

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. {%- endif %}

Deployment

The following details how to deploy this application. {%- if cookiecutter.use_heroku.lower() == "y" %}

Heroku

See detailed cookiecutter-django Heroku documentation.

{%- endif %} {%- if cookiecutter.use_docker.lower() == "y" %}

Docker

See detailed cookiecutter-django Docker documentation.

{%- endif %} {%- if cookiecutter.frontend_pipeline == 'Gulp' %}

Custom Bootstrap Compilation

The generated CSS is set up with automatic Bootstrap recompilation with variables of your choice. Bootstrap v5 is installed using npm and customised by tweaking your variables in static/sass/custom_bootstrap_vars.

You can find a list of available variables in the bootstrap source, or get explanations on them in the Bootstrap docs.

Bootstrap's javascript as well as its dependencies is concatenated into a single file: static/js/vendors.js. {%- endif %}