cookiecutter-django/{{cookiecutter.project_slug}}
Leonardo 907b8ecfbd Remove django-secure (#579)
* Eliminate django-secure from requirements and settings files

* Include secure defaults for django security middleware

* Add settings required by SecurityMiddleware

also remove django-secure in prod settings

* Eliminate empty spaces generated on Jinja on
config/settings/production.py
2016-06-03 16:07:27 -07:00
..
.idea restore pycharm project configuration files 2016-05-01 20:28:34 -03:00
{{cookiecutter.project_slug}} Removed angular2 2016-06-03 14:07:25 -07:00
compose Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
config Remove django-secure (#579) 2016-06-03 16:07:27 -07:00
docs Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
requirements Remove django-secure (#579) 2016-06-03 16:07:27 -07:00
utility Install python3-dev when not using python2 (#551) 2016-05-23 14:46:34 -07: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 Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.gitattributes Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.gitignore removed repo_name references 2016-05-22 20:50:07 +02:00
.pylintrc Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
.travis.yml Removed Hitch per #529 2016-04-25 23:11:17 -07:00
app.json Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
CONTRIBUTORS.txt Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
dev.yml resolved merge conflicts 2016-05-22 20:18:08 +02:00
docker-compose.yml Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
env.example Switch from django-mailgun to django-anymail. Fix #539. 2016-05-27 11:31:30 -07:00
Gruntfile.js resolved merge conflicts 2016-05-22 20:18:08 +02:00
LICENSE Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
manage.py Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
package.json Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
Procfile Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
pytest.ini Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
README.rst resolved merge conflicts 2016-05-22 20:18:08 +02:00
requirements.txt Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
runtime.txt Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00
setup.cfg Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00

{{cookiecutter.project_name}}
==============================

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

Test coverage
^^^^^^^^^^^^^

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

    $ coverage run manage.py test
    $ coverage html
    $ open htmlcov/index.html

Running tests with py.test
~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

  $ py.test

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.

.. _mailhog: https://github.com/mailhog/MailHog

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.

.. _mailhog: https://github.com/mailhog/MailHog

To start the service, make sure you have nodejs installed, and then type the following::

    $ npm install
    $ grunt serve

(After the first run you only need to type ``grunt serve``) This will start an email server that listens on ``127.0.0.1:1025`` in addition to starting your Django project and a watch task for live reload.

To view messages that are sent by your application, open your browser and go to ``http://127.0.0.1:8025``

The email server will exit when you exit the Grunt task on the CLI with Ctrl+C.
{% endif %}
{% endif %}

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

Sentry
^^^^^^

Sentry is an error logging aggregator service. You can sign up for a free account at http://getsentry.com 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
----------

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

Heroku
^^^^^^

.. image:: https://www.herokucdn.com/deploy/button.png
    :target: https://heroku.com/deploy

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 == "y" %}

Docker
^^^^^^

See detailed `cookiecutter-django Docker documentation`_.

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

{% endif %}