Skip to content
This repository has been archived by the owner on Jan 13, 2022. It is now read-only.

Commit

Permalink
Update docs and provide a default env-dist file.
Browse files Browse the repository at this point in the history
  • Loading branch information
pmac committed Aug 14, 2015
1 parent 79e5b12 commit d688ccc
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 8 deletions.
20 changes: 12 additions & 8 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Installing Basket
Requirements
============

* Python >= 2.6, < 3
* MySQL
* Python >= 2.7, < 3
* MySQL (only for prod)

Installation
============
Expand All @@ -32,14 +32,18 @@ Make a virtualenv

Using virtualenvwrapper::

mkvirtualenv --python=python2.6 basket
mkvirtualenv --python=python2.7 basket


Install packages
----------------

::

pip install -r requirements/default.txt

If you'll be using MySQL for the database::

pip install -r requirements/compiled.txt

For developers::
Expand All @@ -50,15 +54,15 @@ For developers::
Settings
--------

Create a settings_local.py file. Typical settings can be found in settings_ex.py
NOTE: make sure you have ``from settings import *`` at the top, or you'll be
confused when things aren't working correctly.

Settings are discovered in the environment. You can either provide them via environment variables
or by providing those variables in a ``.env`` file in the root of the project
(along side of ``manage.py``). To get started you can copy ``env-dist`` to ``.env`` and that will
provide the basics you need to run the site and the tests.

Database schema
---------------

::

./manage.py syncdb --noinput
./manage.py migrate

12 changes: 12 additions & 0 deletions env-dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
DEBUG=1

# change this to something secret when deployed
SECRET_KEY=sssssssshhhhhhhhhh

# should be a UUID and be secret
SUPERTOKEN='2A26AB68-74D8-4C27-BF1A-2A6B61AE52F2'

# this is so you don't need a real queue for development
CELERY_ALWAYS_EAGER=1

ALLOWED_HOSTS='*'

0 comments on commit d688ccc

Please sign in to comment.