Tangent Django Boilerplate

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 \
  --extension="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.

Project title

<TODO: Describe the purpose of this project. What problem is it trying to solve.>

<TODO: Describe any third party integrations.>

<TODO: Describe what technologies are used within the project.>

For everyone

Communication

<TODO: List mailing lists and any other channels for project communication>

Credentials

<TODO: Include credentials for 3rd party systems>

For developers

Local installation

Clone repo, create a virtualenv and run:

$ make

which will install dependencies and build a local database. Running:

$ www/manage.py runserver

will serve the site at http://127.0.0.1:8000/.

<TODO: Describe any further installation instructions>

Tests

Run the test suite using either:

$ make test

or:

$ cd www
$ py.test

See the py.test docs for info on how to run subsets of the test suite.

Continuous integration status:

<TODO: Set project up on Travis to get the correct token for the below image>

Deployment

Deployment uses Fabric. There are helper scripts for each environment:

$ ./deploy-to-test.sh
$ ./deploy-to-stage.sh
$ ./deploy-to-prod.sh

Infrastructure

<TODO: Describe the infrastructure for this project, covering webservers, databases and other services (eg Solr, RabbitMQ). Include versions>

<TODO: List the IP addresses of each server used by this project and any HTTP basic auth credentials>

Monitoring

<TODO: Set project up on Zabbix and include URL here>

<TODO: Set project up on Sentry and include URL here>

Notes

<TODO: Describe any gotchas or unusual parts of the codebase. Assume the person who will take over this project from you is a serial killer who knows where you live.>

<TODO: Describe the reasoning behind major design decisions>

For testers

<TODO: List information that testers will need to know such as testing bankcard numbers.>