Welcome to django-archetype. This project serves as W+K's base django project. Please use it to get your django project up and running quickly. If you've got improvements or fixes to archetype, make a branch, and send them as a pull request!

1. Set up a github repo for your project (aka https://github.com/wieden-kennedy/myproject.git)

2. Clone this repo into your project name, and set up the remotes:

   git clone git@github.com:wieden-kennedy/django-archetype.git archetype
   cd archetype
   git remote set-url origin git@github.com:wieden-kennedy/myproject.git
   git remote add archetype git@github.com:wieden-kennedy/django-archetype.git
   git push -u origin master

3. Set up a virtualenv, and re-freeze the requirements

   mkvirtualenv myproject --no-site-packages
   workon myproject
   pip install -r requirements.unstable.txt
   pip freeze requirements.unstable.txt > requirements.txt

   Note: If you're in rapid-deploy land, just use requirements.txt. It's guaranteed to be stable.

4. Copy env/local.py.dist to env/local.py, and set the name of your virtualenv in it.

5. If you're using AWS (it's set up to, by default):

   • Place your keys into the environment variables, or set them in local.py

   • Create whatever buckets you need:

     ./manage.py create_bucket

6. Set the domain in apps/archetype/fixtures/initial_data.json

7. Run ./manage.py test

8. Run ./manage.py harvest --settings=env.lettuce -d

9. When both of the above pass, uncomment "archetype", in LETTUCE_AVOID_APPS in env/lettuce.py

10. Fill in the settings ADMINS, and set up the EMAIL_SUBJECT_PREFIX in common.py

11. Update README.md with your project's details.

1. Request production access.

2. Verify the email address you want to send from.

   ./manage.py shell_plus

   from boto.ses.connection import SESConnection
   c = SESConnection(aws_access_key_id=settings.AWS_ACCESS_KEY_ID, aws_secret_access_key=settings.AWS_SECRET_ACCESS_KEY)
   c.verify_email_address("outgoingemail@example.com")

Archetype ships with django-analytical built-in. To add analytics, just add their IDs to the common.py settings file.

For instance, to set up Google Analytics Gaug.es, and Mixpanel, add:

MIXPANEL_API_TOKEN = "0d123aa10022334455df12345678c"
GOOGLE_ANALYTICS_PROPERTY_ID = "UA-12345678-90"
GAUGES_SITE_ID = "0d123aa10022334455df12345678c"

0. Uncomment the heroku requirement from requirements.unstable.txt, install, and refreeze.

1. Get the heroku gem, if you don't have it.

   gem install heroku

2. Create a stack:

   heroku create --stack cedar my_app

3. Add the heroku remote

   git remote add heroku git@heroku.com:my_app.git

4. Add some typical services:

   # Backups (Free)
   heroku addons:add pgbackups:auto-month
   
   # Redis (5MB, Free)
   heroku addons:add redistogo:nano
   
   # Memcached (5MB, Free)
   heroku addons:add memcache:5mb
   
   # Dev Database (Postgresql)
   heroku addons:add heroku-postgresql:dev
   
   # Add your domain (You'll need both for www. support.)
   heroku domains:add www.example.com
   heroku domains:add example.com

5. Set your domain's DNS:

6. Deploy (below)

1. Get your live branch ready to go.
2. Re-freeeze the requirements, if you've changed them: pip freeze requirements.unstable.txt > requirements.txt
3. fab deploy_heroku

heroku run python project/manage.py shell_plus

A base set of common fabric commands are included. Right now, that's:

• deploy_static - collects static, compresses them, and syncs them to S3.
• deploy_heroku - full deploy to heroku. Specifically, it:

1. Collects all the static files
2. Combines and compress them
3. Names them uniquely
4. Uploads them, gzipped, with never-expire and proper CORS headers to the S3 bucket
5. Pushes your code to heroku
6. Runs syncdb
7. Runs migrate
8. Restarts your heroku server