Skip to content
A REST API for dustDuino air quality sensors
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.build_scripts
docs
requirements
sensor_rest_api
.gitignore
.travis.yml
LICENSE
Procfile
README.md
app.json
requirements.txt

README.md

A REST API for DustDuino air quality sensors

Deploy

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:

Environment Variable Django Setting Development Default Production Default
DJANGO_SECRET_KEY SECRET_KEY CHANGEME!!! raises error
DJANGO_PORTAL_URL PORTAL_URL http://127.0.0.1:8000 http://127.0.0.1:8000

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
You can’t perform that action at this time.