This is a boilerplate README.rst created from the tangent-django-boilerplate project. This section should be deleted and the below sections completed when the project is created.
Use this project with Django's startproject command:
django-admin.py startproject $PROJECT_NAME --extensions="py,rst,conf,wsgi" --template=https://github.com/tangentlabs/tangent-django-boilerplate/zipball/master
Note that you need to specify a name for the project and pass the following variables:
- client - The client for this project
- project_code - The project code
- domain - The top-level domain for the test/stage sites and the alerts mailing list
- timezone - Which timezone to use in settings.py
Tangent developers can use the tangent-kickstart tool to simplify creation of projects that conform to our conventions:
The below copy contains template variables - it gets merged with a context when a new boilerplate project is created.
[List mailing lists for projects]
[Explain how to set-up the project and run the unit tests]
[Add information useful for testing (eg magic bankcard numbers)]
[List IP addresses and auth details for the various environments]