Skip to content
This repository has been archived by the owner on Feb 8, 2018. It is now read-only.

dustmap/dustmap-server

Repository files navigation

dustmap-server

Build Status

Install / Run

git clone git:https://github.com/dustmap/dustmap-server
cd dustmap-server
cp database.json.example database.json
$EDITOR database.json
export NODE_ENV=<the_environment>
node_modules/.bin/db-migrate --env=$NODE_ENV up
npm start

What is this?

This is the api server component for the dustmap.org project. The project's goal is to

  • develop and deploy el-cheapo hardware (raspberrypi, arduino, ...) to measure environmental data (especially particulate matter)
  • develop software for measuring, transfering, storing and visualizing the recorded data

Every outcome of the project whatsoever should be as open as possible (read: open data, open source software, open hardware, ...)

If you are interested in any of the stuff we (try to) do, feel free to drop us a line at [email protected] ...

Hints

  • You need to setup the connection to your database in database.json in the root of the project
  • You can setup multiple different database connections for different NODE_ENV, check out the database.json.example
  • We currently use hstore. Perhaps this will change in future (we'll perhaps use JSON as a datatype as soon as soon as 9.3 is out ... or not)
  • No Auth/Sign/.../Whatsoever ... coming in future
  • If you need SSL to connect to the database you need to set the environment variable NODE_PG_FORCE_NATIVE (this is the defaul for npm test and npm start)
  • you can change the port(s) the server is listening on with npm config set dustmap-server:http_port 1234. Available config options:
    • http_port
    • https_port
    • https_key
    • https_cert

More or less relevant links

TODO

  • ORM, DB, ...
  • Ratelimit, Upload Limit
  • Validation in application
  • JSON HAL enhancments
  • Caching DB requests, E-Tags, ...
  • perhaps patch pg to switch between natvie and js mode via environment variable (nedd to look into this ...)
  • update / delete resources (?)
  • user / node management
  • static stuff for single site application (?)
  • req.format(...) and other formats
  • daemonizing the server

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published