sensebox/opensensemap-api
the api powering opensensemap.org
100K+
This repository contains the code of the openSenseMap API, which is the HTTP REST API used by https://opensensemap.org running at https://api.opensensemap.org. To get more information about openSenseMap and senseBox visit the before mentioned links or have a look at this video, read the API docs or the openSenseMap chapter in our documentation. openSenseMap is part of the senseBox project.
Originally, this API has been built as part of the bachelor thesis of @mpfeil at the ifgi (Institute for Geoinformatics, WWU Münster). Developers and previous maintainer include @umut0, @felixerdy, @noerw, @chk1 and @ubergesundheit.
You'll find that the repostiory uses yarn workspaces to separate the API and the database models for reuse in other projects. While the API is not published on npm, the package @sensebox/opensensemap-api-models
is published from packages/models folder.
Configuration of both the api and the models is done using mechanisms provided by lorenwest/node-config. You can find an annotated example configuration with all keys in config/config.example.json
.
docker-compose up -d db
)git checkout my-awesome-feature
)yarn install
master
branchSee also: CONTRIBUTING
You can run the tests in containers using Docker and docker-compose.
# Run this the first time or every time you change dependencies in package.json
yarn build-test-env
yarn test
Git Tags are used for Docker hub builds (like v1
). Version number is increased by one for each new version. Docker images are built automatically by the Docker hub for all tags starting with v
Versioned container images
master
branchyarn tag-container
git push origin master
MIT - Matthias Pfeil 2015 - now
docker pull sensebox/opensensemap-api