cuulee / dustduino-server Goto Github PK

A REST API for DustDuino air quality sensors

For API documentation click here.

Deployment to Heroku

Use the heroku button above or manually create an app on heroku and deploy. For configuration purposes, the following table maps environment variables to their Django setting:

Installation on local machine

Create a virtual environment

virtualenv venv
source venv/bin/activate

Install the requirements

pip install -r requirements.txt

Initialize the database

python sensor_rest_api/manage.py syncdb

Start the server

python sensor_rest_api/manage.py runserver

Docs Deployment

This project is set up with Travis deploy scripts already included which will deploy documentation to gh-pages. To utilize these, you will need to enable the repo on the Travis system and include the following two environment variables.

• GH_REF - the URL of the repo, similar to github.com/developmentseed/dustduino-server.git
• GH_TOKEN - a GitHub personal access token available from https://github.com/settings/tokens