Apogaea Volunteer Database

Schema

Contributing

See the Contribution Guide

Development Environment Setup

This is assuming a MacOS X or Linux development environment, with Python 2.7 installed. This will use virtualenv to manage a Django v1.7 project.

1. Install postgres

   This application uses postgresql and memcached in the live environment. If you do not want to configure postgresql for local development work, the default sqlite database will suffice. There are some explicit steps for sqlite installs noted below.

   $ brew install postgresql memcached libmemcached  # Mac
   $ sudo apt-get install -y postgresql python-memcache memcached postgresql-server-dev-all libncurses5-dev libmemcached-dev zlib1g-dev libssl-dev python-dev build-essential git # Ubuntu/Linux
   

   On Mac, I also had to add pg_config to the path for pip to install requirements correctly:

   export PATH=$PATH:/opt/local/lib/postgresql92/bin # Optionally add this to .bashrc

2. Install virtualenv

   First ensure python is installed (it likely is already):

   $ brew install python --with-brewed-openssl # Mac
   $ sudo apt-get install python # Ubuntu Linux (I think this will get latest 2.x)
   

   $ pip install virtualenv           # MacOS
   $ sudo apt-get install virtualenv  # Ubuntu Linux

3. Clone the Apogaea VolDB Git repository

   $ git clone git@github.com:Apogaea/voldb.git

4. Create a virtual environment and activate it

   $ cd voldb
   $ virtualenv env
   $ source env/bin/activate

5. Install application dependencies

   $ pip install -r requirements-dev.txt

   Note: If you are choosing to use SQLite instead of postgresql, you will need to comment the psycopg2 package out of requirements-dev.txt before running 'pip install'. Otherwise, the installation will fail.

   gunicorn==18.0
   ipython==1.2.1
   newrelic==2.18.1.15
   -psycopg2==2.5.4
   +#psycopg2==2.5.4
   pylibmc==1.4.1
   pytz==2014.10
   

6. Setup your database

   $ ./manage.py syncdb

7. Start the Django web application

   This will start a local webserver running on http://localhost:8000

   $ ./manage.py runserver

   This will allow you to develop and reload your changes live in the browser.

   Or to load the development webserver such that other devices on the local network (e.g. tablets) can access it:

   $ python manage.py runserver '[::]:8000'

Running the tests

The tests are run via tox.

$ tox

To run a only the flake8 tests

$ tox -e flake8

To run a only the python tests

$ tox -e py27-django17

Heroku Stuff

The volunteer database, while fundamentally agnostic to the hosting environment, is at the time of writing this, hosted on heroku. The best way as a developer to interact with this is via the heroku cli.

https://devcenter.heroku.com/articles/heroku-command

Here are some basics for how to do stuff on heroku. This is very barebones as, much more detailed instructions are availble on the heroku docs. Most of these docs assume that you know some of the internals of managing a django project.

Deploying

To deploy the latest version from the master branch.

$ git push heroku master

To deploy from a branch that isn't master.

$ git push heroku some_other_branch:master

Often deploying may involve running certain migrations.

$ heroku run python manage.py migrate

Interactive Shell

Similar to running migrations, you may want to jump into a python shell for various reasons.

$ heroku run python manage.py shell

Configuration

The majority of the app is configured via environment variables. You can see a full list of them by running the following.

$ heroku config

Or set/change one

$ heroku config:set DJANGO_DEBUG='True'

Logs

You can see what's going on by tailing the logfiles.

$ heroku logs -t