saurabh1e/revolv

Revolving crowdfunding Django application for RE-volv, a San Francisco based solar energy nonprofit organization.

Revolv

Below you will find basic setup and deployment instructions for the revolv project. To begin you should have the following applications installed on your local development system:

• Python 2.7
• NodeJS >= 4.2
• pip >= 1.5
• virtualenv >= 1.10
• Postgres >= 9.3
• git >= 1.7

A note on NodeJS 4.2 for Ubuntu users: this LTS release may not be available through the Ubuntu repository, but you can configure a PPA from which it may be installed:

curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
sudo apt-get install -y nodejs

You may also follow the manual instructions if you wish to configure the PPA yourself:

https://github.com/nodesource/distributions#manual-installation

Getting Started

First clone the repository from Github and switch to the new directory:

$ git clone [email protected]:RE-volv/revolv.git
$ cd revolv

If you like, you can do all of the following for the first time with the quickstart make target setup, which will install both Python and Javascript dependencies (via pip and npm) into a virtualenv named "venv", configure a local django settings file, and create a database via Postgres named "revolv" with all migrations run:

$ make setup
$ source venv/bin/activate

If you require a non-standard setup, you can walk through the manual setup steps below making adjustments as necessary to your needs.

To setup your local environment you should create a virtualenv and install the necessary requirements:

# Check that you have python2.7 installed
$ which python2.7
$ virtualenv revolv -p `which python2.7`
(revolv)$ pip install -r requirements/dev.txt
(revolv)$ npm install

Next, we'll set up our local environment variables. We use django-dotenv to help with this. It reads environment variables located in a file name .env in the top level directory of the project. The only variable we need to start is DJANGO_SETTINGS_MODULE:

(revolv)$ cp revolv/settings/local.example.py revolv/settings/local.py
(revolv)$ echo "DJANGO_SETTINGS_MODULE=revolv.settings.local" > .env

Create the Postgres database and run the initial migrate:

(revolv)$ createdb -E UTF-8 revolv
(revolv)$ python manage.py migrate

If you want to use Travis to test your project, rename project.travis.yml to .travis.yml, overwriting the .travis.yml that currently exists. (That one is for testing the template itself.):

(revolv)$ mv project.travis.yml .travis.yml

Development

Currently this project assumes some data in the database. To seed the database and aovid 500 errors due to code which can't handle an empty database run:

(revolv)$ ./manage.py seed

You should be able to run the development server via the configured dev script:

(revolv)$ npm run dev

Or, on a custom port and address:

(revolv)$ npm run dev -- --address=0.0.0.0 --port=8020

Any changes made to Python, Javascript or Less files will be detected and rebuilt transparently as long as the development server is running.

Deployment

The deployment of requires Fabric but Fabric does not yet support Python 3. You must either create a new virtualenv for the deployment:

# Create a new virtualenv for the deployment
$ virtualenv revolv-deploy -p `which python2.7`
(revolv-deploy)$ pip install -r requirements/deploy.txt

You can then deploy changes to a particular environment with the deploy command:

$ fab staging deploy

New requirements or migrations are detected by parsing the VCS changes on the production server and will be installed/run automatically.

Deploying to production ----------

To deploy to production, you'll need to be in the list of devs at conf/pillar/devs.sls. If you are, you can run

fab production deploy

The script will take 3-4 minutes to run, please be patient. You should see green output - if you see errors with the following output:

AttributeError: 'Requirement' object has no attribute 'project_name'

Then check out [this issue](saltstack/salt#33163). Usually, ssh'ing into the AWS machine and running sudo pip install pip==8.1.1 will fix this issue.