.github | ||
client_src | ||
design | ||
docs | ||
lantern-build-engine@aaa2463547 | ||
lib/SBRL | ||
logic | ||
test | ||
.gitignore | ||
.gitmodules | ||
api.php | ||
beta | ||
build | ||
Changelog.md | ||
composer.json | ||
composer.lock | ||
di_config.php | ||
index.php | ||
LICENSE | ||
nightdocs.toml | ||
package-lock.json | ||
package.json | ||
README.md | ||
rollup.config.js | ||
settings.default.toml | ||
version |
ConnectedHumber-Air-Quality-Interface
The web interface and JSON API for the ConnectedHumber Air Quality Monitoring Project.
This project contains the web interface for the ConnectedHumber sensor system. Despite being called Air Quality Web, it is designed to display any kind of sensor data - not just air quality sensor readings.
It is composed of 2 parts:
- A PHP-based JSON API server (entry point: api.php) that's backed by a MariaDB server
- A Javascript client application that runs in the browser
The client-side browser application is powered by Leaflet.
Note that this project is not responsible for entering data into the database. This project's purpose is simply to display the data.
Documentation
Documentation has moved! You can view it here:
Branches
master
- The default branch
- Should always be stable
dev
- The development branch
- May not always be stable.
Notes
- Readings are taken every 6 minutes as standard.
Contributing
Contributions are welcome - feel free to open an issue or (even better) a pull request.
The issue tracker is the place where all the tasks relating to the project are kept.
Please remember: All pull requests should be made against the dev
branch, not master! The master
branch is the stable version that automatically gets pushed to production.
Credits
- Map: Leaflet.js showing OpenStreetMaps using various plugins
- Colour manipulation by chroma.js
- Device graphs by chart.js
- Loading Animation
- Some icons from Open Iconic
License
This project is licensed under the Mozilla Public License 2.0. The full text of this license can be found in the LICENSE file of this repository, along with a helpful summary of what you can and can't do provided by GitHub.