mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2024-11-11 04:07:48 +03:00
82 lines
4.4 KiB
ReStructuredText
82 lines
4.4 KiB
ReStructuredText
{{cookiecutter.project_name}}
|
|
==============================
|
|
|
|
{{cookiecutter.description}}
|
|
|
|
|
|
LICENSE: BSD
|
|
|
|
Settings
|
|
------------
|
|
|
|
cookiecutter-django relies extensively on environment settings which **will not work with Apache/mod_wsgi setups**. It has been deployed successfully with both Gunicorn/Nginx and even uWSGI/Nginx.
|
|
|
|
For configuration purposes, the following table maps the cookiecutter-django environment variables to their Django setting:
|
|
|
|
======================================= =========================== ============================================== ===========================================
|
|
Environment Variable Django Setting Development Default Production Default
|
|
======================================= =========================== ============================================== ===========================================
|
|
DJANGO_AWS_ACCESS_KEY_ID AWS_ACCESS_KEY_ID n/a raises error
|
|
DJANGO_AWS_SECRET_ACCESS_KEY AWS_SECRET_ACCESS_KEY n/a raises error
|
|
DJANGO_AWS_STORAGE_BUCKET_NAME AWS_STORAGE_BUCKET_NAME n/a raises error
|
|
DJANGO_CACHES CACHES locmem memcached
|
|
DJANGO_DATABASES DATABASES See code See code
|
|
DJANGO_DEBUG DEBUG True False
|
|
DJANGO_EMAIL_BACKEND EMAIL_BACKEND django.core.mail.backends.console.EmailBackend django.core.mail.backends.smtp.EmailBackend
|
|
DJANGO_SECRET_KEY SECRET_KEY CHANGEME!!! raises error
|
|
DJANGO_SECURE_BROWSER_XSS_FILTER SECURE_BROWSER_XSS_FILTER n/a True
|
|
DJANGO_SECURE_SSL_REDIRECT SECURE_SSL_REDIRECT n/a True
|
|
DJANGO_SECURE_CONTENT_TYPE_NOSNIFF SECURE_CONTENT_TYPE_NOSNIFF n/a True
|
|
DJANGO_SECURE_FRAME_DENY SECURE_FRAME_DENY n/a True
|
|
DJANGO_SECURE_HSTS_INCLUDE_SUBDOMAINS HSTS_INCLUDE_SUBDOMAINS n/a True
|
|
DJANGO_SESSION_COOKIE_HTTPONLY SESSION_COOKIE_HTTPONLY n/a True
|
|
DJANGO_SESSION_COOKIE_SECURE SESSION_COOKIE_SECURE n/a False
|
|
======================================= =========================== ============================================== ===========================================
|
|
|
|
* TODO: Add vendor-added settings in another table
|
|
|
|
Developer Installation
|
|
-----------------------
|
|
|
|
For getting this running on your local machine:
|
|
|
|
1. Set up a virtualenv.
|
|
2. Install all the supporting libraries into your virtualenv::
|
|
|
|
pip install -r requirements/local.txt
|
|
|
|
3. Install Grunt Dependencies.
|
|
|
|
npm install
|
|
|
|
4. Run development server. (For browser auto-reload, use Livereload_ plugins.)
|
|
|
|
grunt serve
|
|
|
|
.. _livereload: https://github.com/gruntjs/grunt-contrib-watch#using-live-reload-with-the-browser-extension
|
|
|
|
|
|
Deployment
|
|
------------
|
|
|
|
Run these commands to deploy the project to Heroku:
|
|
|
|
.. code-block:: bash
|
|
|
|
heroku create --buildpack https://github.com/heroku/heroku-buildpack-python
|
|
heroku addons:add heroku-postgresql:dev
|
|
heroku addons:add pgbackups:auto-month
|
|
heroku addons:add sendgrid:starter
|
|
heroku addons:add memcachier:dev
|
|
heroku pg:promote HEROKU_POSTGRESQL_COLOR
|
|
heroku config:set DJANGO_CONFIGURATION=Production
|
|
heroku config:set DJANGO_SECRET_KEY=RANDOM_SECRET_KEY
|
|
heroku config:set DJANGO_AWS_ACCESS_KEY_ID=YOUR_ID
|
|
heroku config:set DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_KEY
|
|
heroku config:set DJANGO_AWS_STORAGE_BUCKET_NAME=BUCKET
|
|
git push heroku master
|
|
heroku run python {{cookiecutter.repo_name}}/manage.py syncdb --noinput --settings=config.settings
|
|
heroku run python {{cookiecutter.repo_name}}/manage.py migrate --settings=config.settings
|
|
heroku run python {{cookiecutter.repo_name}}/manage.py collectstatic --settings=config.settings
|
|
|