Development

Requirements

• python 2.7, virtualenv, & pip for app server
• elasticsearch

Install Locally

1. Clone and change to the directory:

   git clone git@github.com:codefortulsa/city-struggle-bus.git
   cd city-struggle-bus
   

2. Create and activate a virtual environment (Can also use virtualenvwrapper):

   virtualenv env
   source env/bin/activate
   

3. Install requirements:

   pip install -r requirements.txt
   

4. Source the .env file to set environment config vars (Can also use autoenv):

   source .env
   

5. `Migrate`_ DB tables

   python manage.py migrate
   

6. Create a superuser:

   python manage.py createsuperuser
   

Run it

1. Source the .env file to set environment config vars (Can also use autoenv):

   source .env
   

2. Activate the virtual environment (Can also use virtualenvwrapper):

   source env/bin/activate
   

3. Run it:

   python manage.py runserver
   

Run the Tests

1. Install test requirements:

   pip install -r requirements-test.txt
   

2. Running the test suite:

   python manage.py test
   

Working on Docs

Install doc requirements:

pip install -r requirements-docs.txt

Building the docs is easy:

cd docs
sphinx-build . html

Read the beautiful docs:

open html/index.html

What to work on

We have Issues.