search

calblueprint / revolv

Revolving crowdfunding Django application for RE-volv, a San Francisco based solar energy nonprofit organization. This project has launched: see https://github.com/RE-volv/revolv
http://www.re-volv.org
29 stars 12 forks source link

readme

RE-volv

This application allows RE-volv to crowdfund donations to community solar projects in order to promote renewable energy and help save the planet. Learn more about Blueprint's work with RE-volv on our blog.

Staging URL: http://revolv-stage.herokuapp.com/

Codeship

Who We Are

bp Cal Blueprint is a student-run UC Berkeley organization devoted to matching the skills of its members to our desire to see social good enacted in our community. Each semester, teams of 4-5 students work closely with a non-profit to bring technological solutions to the problems they face every day.

Contributing

All of Blueprint's work is open source and we welcome contributions. If you would like to contribute to work on this project, please open an issue and we'll work to get your environment set up.

Task tracking and priority

All task tracking is done via the github issues page, and every issue will be triaged when it's opened. Please use Zenhub to view issue pipelines. For non-chrome users, each issue is tagged with a priority of 1, 2, 3, 4, or 5, with 1 being highest priority. In general, higher priority issues should always be worked on first.

Installation

You can choose to use vagrant or not. Note that in either case, you will need to acquire Paypal and Amazon API keys from one of the maintainers, or the app will not work locally.

If not using vagrant, first install PostgreSQL and set up a database and user with the credentials in the DATABASES setting from revolv/settings.py. Then:

$ pre-commit install
$ npm install -g grunt-cli
$ npm install -g bower
$ npm install
$ bower install
$ grunt sass
$ pip install -r requirements.txt
$ python manage.py migrate
$ python manage.py runserver
$ python manage.py seed

If using vagrant:

  1. Install Virtualbox
  2. Install vagrant
  3. vagrant up --provision
  4. python vmanage.py migrate
  5. python vmanage.py runserver
  6. python vmanage.py seed

Additional Environment Variables

There are some additional environment variables need to be configured. See revolv_bash_profile.example. They are all about third-party service integration like social login integration.

Variable Description
SOCIAL_AUTH_FACEBOOK_KEY Facebook App ID
SOCIAL_AUTH_FACEBOOK_SECRET Facebook App Secret
SOCIAL_AUTH_GOOGLE_OAUTH2_KEY Google Oauth2 Client ID
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET Google Oauth2 Client Secret
SHARETHIS_PUBLISHER_ID ShareThis Publisher ID
SFDC_ACCOUNT Salesforce username
SFDC_PASSWORD Salesforce password
SFDC_TOKEN Salesforce Security Token

Just copy revolv_bash_profile.example to .revolv_bash_profile, and make change to that file. If not using vagrant execute source .revolv_bash_profile before running python manage.py runserver

Development

  1. Running grunt watch will start a process which will watch for changes to specific SCSS files (defined in Gruntfile) and will autocompile them to CSS.
  2. You can use the vmanage.py script to run manage.py commands on the running vagrant machine without having to vagrant ssh in. For example: python vmanage.py runserver, python vmanage.py migrate, python vmanage.py makemigrations --empty, etc.
  3. You can run manage.py seed to seed the database, and you can run manage.py seed --clear to clear the seeded data (useful for when something goes wrong and you want to regenerate all the seed data from scratch). You can also run manage.py seed revolvuserprofile to seed specific data (replace revolvuserprofile with any of the strings from revolv/base/management/commands/seed.py).