waterbeacon
Switch branches/tags
Clone or download
mosesmc52 Merge pull request #1 from andrew-ware/master
Add Installation Guide to README
Latest commit d2923ec Oct 8, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api no message Jan 23, 2018
app no message Aug 7, 2018
bin initial upload Oct 4, 2016
docs no message Dec 19, 2017
news no message Dec 19, 2017
pywqp no message Jan 23, 2018
settings Updating water beacon app crawling news feeds from twitter Dec 1, 2017
static no message Aug 21, 2018
templates no message Oct 2, 2018
utils Class used to calculate water quality index Feb 13, 2018
waterquality Updating water beacon app crawling news feeds from twitter Dec 1, 2017
.gitignore Initial commit Oct 2, 2016
README.md Prettier changes to README.md Oct 2, 2018
__init__.py initial upload Oct 4, 2016
db.sqlite3 no message Aug 7, 2018
manage.py initial upload Oct 4, 2016
requirements.txt no message Aug 7, 2018
supervisord.conf initial upload Oct 4, 2016

README.md

waterbeacon

waterbeacon

Resources

https://www.waterqualitydata.us/

NSF Water Quality Index

http://home.eng.iastate.edu/~dslutz/dmrwqn/water_quality_index_calc.htm

Installation Guide

You'll need to install python2 along with pip.

Next, you'll need to install python virtual environment wrapper. You can do so by running pip install virtualenvwrapper.

Now, activate a python virtual environment by running mkvirtualenv ${ENV_NAME}. The ENV_NAME is arbitrary. We'll use "wb" for simplicity.

Finally, run pip install -r requirements.txt to install necessarry dependencies.

When that completes, run ./manage.py migrate --settings=settings.dev to create a local SQLite db instance for developnent.

Finally, run ./manage.py runserver --settings=settings.dev to kick off a dev server.

The dev server will run on localhost:8000 by default. If you prefer another port, just pass the desired port number following the previous command. That is ./manage.py migrate --settings=settings.dev ${PORT}

Note: to deactive the virtual env wrapper, just run deactivate.