Development Guide to Getting Started

This is a guide to get started developing on the Crisis Cleanup codebase.

Crisis Cleanup is a Google App Engine application (GAE), written in Python, so you will need the GAE Python SDK.

1. Create a top-level project directory/folder.
2. Download the SDK for your platform from https://developers.google.com/appengine/downloads
3. Install the SDK for your platform as per https://developers.google.com/appengine/docs/python/gettingstartedpython27/devenvironment
4. (Recommended, but optional) Create a python virtualenv using Python v2.7 for the project and enter it.
5. Install Python Fabric and PyYAML (to the virtualenv): pip install fabric PyYAML
6. Clone the git repository to your project directory using the repository URL from https://github.com/aarontitus/crisiscleanup : git clone <repository URL>
7. In the repository directory, run fab write_local_app_yaml to generate an app.yaml file for the development server to read.
8. Run fab dev to start the development server. (If an error occurs, try editing fabfile.py to direct the script to where you put the SDK.
9. Browse to the local address given when the development server starts up. You can login as the "Admin" user using the password "temporary_password".

MacOS GUI

To use the GoogleAppengineLauncher GUI app, you should:

1. Copy GoogleAppEngineLauncher.app to the Application folder
2. In GoogleAppEngineLauncher preferences set the Python Path (e.g. /Library/Frameworks/Python.framework/Versions/2.7/bin/python)
3. In GoogleAppEngineLauncher click on File/Add Existing Application and select the directoy of the app (sandy-disaster-recovery)
4. Click on "Run"