@sensebox/opensensemap-api-models

openSenseMap data models and database connection

Usage no npm install needed!

<script type="module">
  import senseboxOpensensemapApiModels from 'https://cdn.skypack.dev/@sensebox/opensensemap-api-models';
</script>

README

@sensebox/opensensemap-api-models

Data models and database connection for openSenseMap

NPM Version

require() openSenseMap API models

Install it as dependency: npm install --save @sensebox/opensensemap-api-models or yarn add @sensebox/opensensemap-api-models

This allows you to use parts like models and decoding in your own project. See index.js.

Configuration

The package uses lorenwest/node-config. The available configuration keys can be found in the index.js file. If you need an example for configuring the package, take a look at the docker-compose.yml file of the api tests.

Changelog

See CHANGELOG.md

Releasing a new version

  1. Document your changes in CHANGELOG.md. Do not git add the file.
  2. Run yarn version
  3. git push --tags origin master
  4. npm publish
  5. Use the new version in the api package

License

MIT - Matthias Pfeil 2015 - now

Maintained by Gerald Pape