cookiecutter-django/{{cookiecutter.project_slug}}
2021-01-31 05:43:22 -08:00
..
.envs Merge pull request #2435 from Andrew-Chen-Wang/master 2020-03-16 19:59:25 +00:00
.github Fix docker container stop command on github action 2021-01-18 18:05:22 -03:00
.idea Don't include POSTGRES_... environment in the PyCharm start script when not using Docker 2020-02-03 14:29:20 +00:00
{{cookiecutter.project_slug}} Merge pull request #3018 from Andrew-Chen-Wang/patch-6 2021-01-26 18:51:00 +00:00
bin Fix issue with Heroku + Django Compressor 2020-07-04 15:20:51 +01:00
compose Merge branch 'master' into test 2021-01-24 17:06:43 +00:00
config Sentry Redis integration enabled by default in production. 2020-12-31 14:02:53 +01:00
docs Fix docs service and add RTD support (#2920) 2020-11-04 17:17:02 +00:00
locale Move to the python:alpine docker image (#1482) 2018-02-22 10:01:05 -05:00
requirements Update django-crispy-forms from 1.10.0 to 1.11.0 2021-01-31 05:43:22 -08:00
utility Add Debian 10 (buster) OS dependencies 2019-12-22 12:52:22 +01:00
.dockerignore Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.editorconfig Test isort flake8-isort & fix issues 2020-03-03 20:04:31 +00:00
.gitattributes Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.gitignore Clean up nested venv files from .gitignore 2020-09-07 15:30:37 +02:00
.gitlab-ci.yml Updated Gitlab CI to use Python 3.8 instead of Python 3.7 (#2794) 2020-09-07 13:28:49 +01:00
.pre-commit-config.yaml Auto-update pre-commit hooks 2021-01-01 00:39:49 +00:00
.pylintrc add plugins to req file; remove pylint-common 2019-03-23 00:01:23 -04:00
.readthedocs.yml Fix docs service and add RTD support (#2920) 2020-11-04 17:17:02 +00:00
.travis.yml Upgrade Travis to Focal 2021-01-07 22:34:39 -05: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 Gulp watcher fix for win10 fixes #2642 2020-06-28 18:38:29 +02:00
LICENSE Remove Apache LICENSE Appendix 2020-04-14 11:50:44 -04:00
local.yml Fix docs service and add RTD support (#2920) 2020-11-04 17:17:02 +00:00
manage.py Handle path with pathlib 2019-07-10 20:35:38 +02:00
merge_production_dotenvs_in_dotenv.py Nicer syntax to join paths 2020-03-17 15:46:55 +00:00
package.json Add a node image to run Gulp when selecting it with Docker (#1687) 2019-03-25 12:10:55 +00:00
Procfile Added Heroku and Gulp support 2020-04-13 10:57:42 -04:00
production.yml Add :z/:Z to mounted volumes in {local,production}.yml (#2663) 2020-09-07 13:51:52 +01:00
pytest.ini Use pytest-django --reuse-db for faster tests 2019-11-13 23:28:38 +01:00
README.rst Add logo to badge 2021-01-24 23:16:45 +00:00
requirements.txt Simplify post hook 2018-03-04 14:43:54 +03:00
runtime.txt Update Heroku runtime to python3.8.7 2021-01-18 19:38:53 -03:00
setup.cfg chore: exclude venv directory 2020-08-29 11:53:24 +08:00

{{cookiecutter.project_name}}
{{ '=' * cookiecutter.project_name|length }}

{{cookiecutter.description}}

.. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter
     :target: https://github.com/pydanny/cookiecutter-django/
     :alt: Built with Cookiecutter Django
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
     :target: https://github.com/ambv/black
     :alt: Black code style
{% if cookiecutter.open_source_license != "Not open source" %}

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

Settings
--------

Moved to settings_.

.. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html

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 an **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 py.test
~~~~~~~~~~~~~~~~~~~~~~~~~~

::

  $ pytest

Live reloading and Sass CSS compilation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Moved to `Live reloading and SASS compilation`_.

.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html

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

Celery
^^^^^^

This app comes with Celery.

To run a celery worker:

.. code-block:: bash

    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.

#. `Download the latest MailHog release`_ for your OS.

#. Rename the build to ``MailHog``.

#. Copy the file to the project root.

#. Make it executable: ::

    $ chmod +x MailHog

#. Spin up another terminal window and start it there: ::

    ./MailHog

#. 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.

.. _`Download the latest MailHog release`: https://github.com/mailhog/MailHog/releases
{% endif %}
.. _mailhog: https://github.com/mailhog/MailHog
{% 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 setup 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`_.

.. _`cookiecutter-django Heroku documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-on-heroku.html
{% endif %}
{% if cookiecutter.use_docker.lower() == "y" %}

Docker
^^^^^^

See detailed `cookiecutter-django Docker documentation`_.

.. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html
{% endif %}

{% if cookiecutter.custom_bootstrap_compilation == "y" %}
Custom Bootstrap Compilation
^^^^^^

The generated CSS is set up with automatic Bootstrap recompilation with variables of your choice.
Bootstrap v4 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`_.

{% if cookiecutter.js_task_runner == 'Gulp' %}
Bootstrap's javascript as well as its dependencies is concatenated into a single file: ``static/js/vendors.js``.
{% endif %}

.. _in the bootstrap source: https://github.com/twbs/bootstrap/blob/v4-dev/scss/_variables.scss
.. _Bootstrap docs: https://getbootstrap.com/docs/4.1/getting-started/theming/

{% endif %}