# Kamil Documentation Start:

1. Install cookie-cutter project:

   https://github.com/pydanny/cookiecutter-django#usage
   

2. Create and activate your virtualenv:

   https://github.com/kamilski81/django_tutorial
   

3. Install all the local, and test requirements:

   $ pip install -r requirements/local.txt
   $ pip install -r requirements/test.txt
   

4. Run the tests:

   $ python3 manage.py test
   

5. Read docs/pycharm/configuration.rst to debug your Docker tests and server.

# Kamil Docuemntation End

# Cookie Cutter Existing Documentation Start:

Cookie Cutter Sample

A short description of the project.

License:	MIT

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

Celery

This app comes with Celery.

To run a celery worker:

cd cookie_cutter_sample
celery -A cookie_cutter_sample.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.

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.

Deployment

The following details how to deploy this application.

Docker

See detailed cookiecutter-django Docker documentation.

# Cookie Cutter Existing Documentation End