cookiecutter-django/{{cookiecutter.project_slug}}
Bruno Alla 563e0938a8
Merge pull request #1664 from pydanny/clean-up-project-docs
Remove project doc files likely to remain unused
2019-03-13 14:40:18 -03:00
..
.envs Merge branch 'master' into conditional-redis-merge 2019-03-11 20:53:36 +00:00
.idea Re-write users app tests in pytest style & perform minor refactoring (#1680) 2018-06-27 19:33:38 +03:00
{{cookiecutter.project_slug}} updated spacing utility class name 2018-11-30 18:12:08 +13:00
compose Merge branch 'master' into conditional-redis-merge 2019-03-11 20:53:36 +00:00
config Change eager celery setting in local Docker (#1945) 2019-03-02 13:51:30 +00:00
docs Remove project doc files likely to remain unused 2018-05-25 12:16:04 +03:00
locale Move to the python:alpine docker image (#1482) 2018-02-22 10:01:05 -05:00
requirements Update django from 2.0.10 to 2.0.13 (#1936) 2019-02-16 14:34:11 +03:00
utility Prettify generated project requirements (#1557) 2018-03-09 12:57:32 +03:00
.coveragerc Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.dockerignore Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.editorconfig Update nginx.conf (#808) 2016-09-20 23:22:47 +02:00
.gitattributes Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.gitignore Keep ipython history (#1836) 2018-10-24 13:37:15 +03:00
.pylintrc Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.travis.yml Add missing script key to Travis CI config (#1950) 2019-03-05 22:10:45 -03:00
CONTRIBUTORS.txt Add spaces around templated author name 2016-08-24 15:48:03 -07:00
COPYING Add GPLv3 licence support 2016-06-24 16:59:55 +02:00
gulpfile.js Make requested changes: 2019-02-27 10:11:20 +11:00
LICENSE Add GPLv3 licence support 2016-06-24 16:59:55 +02:00
local.yml Rename project template Docker Compose volumes 2018-06-27 19:52:06 +03:00
manage.py First pass at running black across the project (#1602) 2018-04-08 17:03:29 -05:00
merge_production_dotenvs_in_dotenv.py First pass at running black across the project (#1602) 2018-04-08 17:03:29 -05:00
package.json Update Gulp & other dependencies 2019-02-23 18:47:30 +11:00
Procfile Add automatic migrations to heroku deploys (#1951) 2019-03-11 21:05:31 +00:00
production.yml Rename project template Docker Compose volumes 2018-06-27 19:52:06 +03:00
pytest.ini Prettify template's pytest.ini 2018-03-09 13:06:45 +03:00
README.rst Cleanup outdated references to Grunt - fixes #1721 2018-08-30 20:34:56 +01:00
requirements.txt Simplify post hook 2018-03-04 14:43:54 +03:00
runtime.txt Update to latest bug fix for Python 3.6 to fix Heroku warning when deploying 2019-03-11 22:02:11 +00:00
setup.cfg Add mypy to the local dependencies 2018-07-02 10:22:48 +03:00

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

{{cookiecutter.description}}

.. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg
     :target: https://github.com/pydanny/cookiecutter-django/
     :alt: Built with Cookiecutter Django
{% 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 {{cookiecutter.project_slug}}.taskapp 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.1.1 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 %}