getting_started

Getting Started

Core Dependencies

Project Comport is a Flask app. It uses Postgres for a database. Big thanks to the cookiecutter-flask for a great kickstart.

It is highly recommended that you use use virtualenv (and virtualenvwrapper for convenience). For a how-to on getting set up, please consult this how-to and make sure that you create a python3 virtual env. It is recommended that you use postgres.app to handle your Postgres (assuming you are developing on OSX).

Installation and Bootup

After you've created your python 3 virtualenv and activated it, run the following:

mkdir comport
cd comport
git clone git@github.com:codeforamerica/comport.git
psql -c 'create database comport;'
pip install -r requirements.txt
pip install -r requirements/dev.txt
python manage.py db upgrade
python manage.py server

If you see the flask development server running and the splash page at localhost:5000 you're good!