opensensemap

!openSenseMap


This repository contains the code of the openSenseMap frontend running at https://opensensemap.org. To get more information about openSenseMap and senseBox visit the before mentioned links or have a look at this video or read the openSenseMap chapter in our books. openSenseMap is part of the [senseBox] project.

Originally, this frontend has been built as part of the bachelor thesis of @mpfeil at the ifgi (Institute for Geoinformatics, WWU Münster) and is currently maintained by @mpfeil.

The easiest way to get up and running with your own copy is clicking the Deploy to Netlify button below. It will clone the repository into your own account, and deploy the site to Netlify. It is going to ask for Maptiles url and API endpoint. Please use the default values listed under configuration or use your own.


Configuration

You can configure the API endpoint and/or map tiles using the following environmental variables:

| ENV | Default value |
| --------- | ----------------- |
| OPENSENSEMAP_API_URL | https://api.testing.opensensemap.org |
| OPENSENSEMAP_MAPTILES_URL | http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png |

You can set them in your terminal or change the default values in the Gruntfile.

Development

- Have [Node.js] v8, [grunt]() and [bower]() installed
- Check out development branch (git checkout development)
- Run npm install and npx bower install
- Create your own branch git checkout -b my-awesome-branch
- Run frontend in development mode (npx grunt serve)
- Commit your changes to your branch and push it to your fork
- Create a pull request against the development branch

See also: CONTRIBUTING

Related projects

$3

- openSenseMap Backend
- openSenseMap translations

$3

- OSeM-compose
- openSenseMap-infrastructure

Technologies

* [AngularJS]

Organization

$3

- master (runs in production)
- Is used for container build tags
- development (runs on testing server)
- Bleeding edge and possibly unstable development version

Docker

$3

For installing openSenseMap and openSenseMap-API with Docker check out our oSeM-compose repository.

$3

To build just openSenseMap you can run:
``docker build -t osem .`

Following `build-args`` are availble:

| Build Arg | Default value |
| --------- | ----------------- |
| OPENSENSEMAP_API_URL | https://api.opensensemap.org |
| OPENSENSEMAP_MAPTILES_URL | http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png |

License

MIT - Matthias Pfeil 2015 - now

[AngularJS]:https://angularjs.org/
[Node.js]:http://nodejs.org/
[openSenseMap]:https://opensensemap.org/
[senseBox]:https://sensebox.de/