OS X Setup

Install all the things

1. Install Git. You can do this by installing XCode Command Line tools.
2. Install brew.
3. brew install python. This also installs pip.
4. pip install virtualenv
5. pip install virtualenvwrapper
6. brew install [email protected]. IMPORTANT: Read what brew tells you. You might want to make start postgresql at login ln -sfv /usr/local/opt/postgresql/*.plist ~/Library/LaunchAgents and then load postgresql now with launchctl load ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist.
7. brew install postgis
8. Check for errors with brew doctor if desired.

Download this project!

1. git clone https://github.com/greenstreetsinitiative/checkin2015.git OR fork (via the Github website) and clone your fork.
2. Navigate to the checkin2015 directory in your terminal.

Setup the database

1. initdb /usr/local/var/postgres -E utf8
2. createuser -d -P postgres creates a role that can make databases.
3. pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start & if the server is not already running.
4. createuser django
5. createdb -O django checkin
6. psql -d checkin -c "ALTER USER django WITH PASSWORD 'django';"
7. psql -d checkin -c "CREATE EXTENSION postgis;"

Setup the virtual environment

1. mkvirtualenv greenstreets. You can name it other than greenstreets too.
2. Find .virtualenvs/greenstreets/bin/postactivate and edit that file to include the environment variables:

export SECRET_KEY="abcdef"
export DB_NAME="checkin"
export DB_USER="django"
export DB_PASSWORD="django"
export DB_PORT="5432"
export DB_HOST="localhost"
export EMAIL_HOST_USER="xten"
export EMAIL_HOST_PASSWORD="xten"
export MANDRILL_API_KEY="V62ndycapG44sI-x9EcG1A"

3. workon greenstreets. This activates the virtual environment.

Run it

1. pip install -r requirements.txt
2. python manage.py migrate
3. If you have data...
   • then run: python manage.py loaddata data.json
   • else, see the next section Populate the database with dummy data
4. python manage.py runserver

Populate the database with dummy data

The survey app needs some modes and employers defined in the database in order to work properly. The following steps will populate the appropriate database tables with some dummy default values.

1. psql -d checkin -c "INSERT INTO survey_mode VALUES (0, 'Biking', 6.8, 0, 11, TRUE);"
2. psql -d checkin -c "INSERT INTO survey_mode VALUES (1, 'Driving alone', 0, 518, 39.3, FALSE);"
3. psql -d checkin -c "INSERT INTO survey_employer VALUES (0, 'test employer 1', 1, FALSE, NULL, TRUE, FALSE);"
4. psql -d checkin -c "INSERT INTO survey_employer VALUES (1, 'test employer 2', 1, FALSE, NULL, TRUE, TRUE);"
5. psql -d checkin -c "INSERT INTO survey_month VALUES (0, '2019-02-01', '2010-01-01', '2019-01-29');"
   • Note: The above command sets Walk/Ride Day to some time way in the future, but activates the checkin now. Just don't be surprised when you see "this month" and "2019" in the same sentence.

Debian 8 GNU/Linux Setup

Install all the things

1. Become root: su root
2. apt-get install postgresql postgis postgresql-client postgresql-server-dev python-dev virtualenvwrapper python-pip bash-completion

Setup the database

1. Become postgres: su postgres
2. createuser django
3. createdb -O django checkin
4. psql -d checkin -c "ALTER USER django WITH PASSWORD 'django';"
5. psql -d checkin -c "CREATE EXTENSION postgis;"
6. exit

Setup the virtual environment

1. Become a normal user: su <username> (replace <username> with your normal development user)

   • If you don't have a normal user in your VM yet, make one first: adduser guest

2. git clone <URL of this repository>

3. cd <this repository>

4. source /etc/bash_completion

5. mkvirtualenv greenstreets

6. Setup the environment variables in the postactivate script:

   echo >>~/.virtualenvs/greenstreets/bin/postactivate <<EOF
   export SECRET_KEY="abcdef"
   export DB_NAME="checkin"
   export DB_USER="django"
   export DB_PASSWORD="django"
   export DB_PORT="5432"
   export DB_HOST="localhost"
   export EMAIL_HOST_USER="xten"
   export EMAIL_HOST_PASSWORD="xten"
   export MANDRILL_API_KEY=""
   export MAPQUEST_API_KEY=""
   EOF
   

7. workon greenstreets

Run it

1. pip install -r requirements.txt
2. python manage.py migrate
3. If you have data...
   • then run: python manage.py loaddata data.json
   • else, see the next section Populate the database with dummy data
4. python manage.py runserver 0.0.0.0:8000
5. Navigate to the IP address of your debian VM in your web browser, port 8000.

Populate the database with dummy data

The survey app needs some modes and employers defined in the database in order to work properly. The following steps will populate the appropriate database tables with some dummy default values.

1. Become postgres: su postgres
2. psql -d checkin -c "INSERT INTO survey_mode VALUES (0, 'Biking', 6.8, 0, 11, TRUE);"
3. psql -d checkin -c "INSERT INTO survey_mode VALUES (1, 'Driving alone', 0, 518, 39.3, FALSE);"
4. psql -d checkin -c "INSERT INTO survey_employer VALUES (0, 'test employer 1', 1, FALSE, NULL, TRUE, FALSE);"
5. psql -d checkin -c "INSERT INTO survey_employer VALUES (1, 'test employer 2', 1, FALSE, NULL, TRUE, TRUE);"
6. psql -d checkin -c "INSERT INTO survey_month VALUES (0, '2019-02-01', '2010-01-01', '2019-01-29');"
   • Note: The above command sets Walk/Ride Day to some time way in the future, but activates the checkin now. Just don't be surprised when you see "this month" and "2019" in the same sentence.
7. exit

Django admin interface

The admin interface is useful for easily editing the database. First, set up an admin user:

python manage.py createsuperuser

then just navigate to /admin and login.

Run tests

1. pip install -r requirements.txt
2. pip install -r test-requirements.txt
3. python manage.py test --settings=checkin2015.dev

Bonus: Export data to CSV

psql -d checkin -c "\copy (select checkins.*, legs.* from (select a.id, a.name, a.email, orgs.employer_name, orgs.team_name, a.share, a.home_address, a.work_address, a.comments, a.carbon_change, a.carbon_savings, a.calorie_change, a.calories_total, a.change_type, a.already_green from survey_commutersurvey a left outer join (select m.id as employer_id, m.name as employer_name, n.id as team_id, n.name as team_name from survey_employer m left outer join survey_team n on m.id = n.parent_id) orgs on (a.employer_id = orgs.employer_id and a.team_id = orgs.team_id)) checkins right outer join (select x.checkin_id, x.day, x.direction, y.name, x.duration  from survey_leg x, survey_mode y where x.mode_id = y.id) legs on checkins.id = legs.checkin_id) to ../Checkins.csv CSV HEADER"

Deployment Instructions

1. Complete "Setting Up Your Machine" at https://developers.openshift.com/managing-your-applications/client-tools.html
2. https://www.openshift.com/
3. Click My Account -> OpenShift Web Console
4. Log-in with the username and password
5. Click checkindev under applications
6. Copy the Source Code on the right side
7. Clone the repository (e.g. "git clone ssh://57b...")
8. Change directories to the cloned repo.
9. Connect a new repo via an upstream (e.g. "git remote add upstream -m master git://github.com/openshift/django-example.git")
10. Pull the upstream repo (e.g. "git pull -s recursive -X theirs upstream master")
11. Run "git push" to finish the update