sbrl-github/Air-Quality-Web
1
0
Fork 0
mirror of https://github.com/ConnectedHumber/Air-Quality-Web synced 2024-12-21 10:25:00 +00:00
Code Issues Releases Wiki Activity
*** Backup Mirror *** The web interface and JSON api for the ConnectedHumber Air Quality Monitoring Project. https://github.com/ConnectedHumber/Air-Quality-Web
434 commits 12 branches 0 tags 2 MiB
JavaScript 46.1%
PHP 43.1%
Shell 7.6%
CSS 2.6%
HTML 0.6%
Find a file
Starbeamrainbowlabs e686444200
Update dependencies
2020-04-05 21:12:22 +01:00
.github Bugfix: typo 2019-02-23 20:03:12 +00:00
client_src Implement a colourizer algorithm, but there's a better way of doing it with SVG. 2020-04-02 22:13:46 +01:00
design Add application structure SVG diagram 2019-03-01 17:46:06 +00:00
docs Update documentation - air quality - sensor 2019-10-10 21:16:12 +01:00
lantern-build-engine@aaa2463547 Bugfix: Correct and document GenerateCSSGradient(). 2019-05-09 11:41:35 +01:00
lib/SBRL Drastically optimise the queries behind fetch-data and device-data. 2019-06-22 21:08:12 +01:00
logic Bugfix: Fix error in list-devices-near error 2020-03-05 18:52:53 +00:00
test Add heatmap guage to right-hand-side (part of #31) 2019-05-09 13:32:01 +01:00
.gitignore Update db connection info 2019-11-07 18:43:01 +00:00
.gitmodules Remove webgl heatmap, as it doesn't work right. 2019-01-18 19:45:28 +00:00
api.php Allow CORS access from IPv6 localhost 2019-07-29 21:31:23 +01:00
beta Add beta version symlink 2019-08-01 18:47:19 +01:00
build Bugfix: Don't unwind the ./beta symlink 2020-03-08 18:16:21 +00:00
Changelog.md Disable the tour, since it's causing a crash on startup 2020-04-02 20:26:48 +01:00
composer.json Add list-devices-near action with appropriate API documentation 2019-06-21 22:05:13 +01:00
composer.lock Add list-devices-near action with appropriate API documentation 2019-06-21 22:05:13 +01:00
di_config.php Bugfix new device sensor list 2019-07-18 22:18:30 +01:00
index.php Add premanent redirect from root to app/ 2019-04-12 23:15:42 +01:00
LICENSE Initial commit 2019-01-12 23:22:42 +00:00
nightdocs.toml Use nightdocs to generate documentation 2019-03-17 13:21:14 +00:00
package-lock.json Update dependencies 2020-04-05 21:12:22 +01:00
package.json Update dependencies 2020-04-05 21:12:22 +01:00
README.md Docs: URL update 2019-12-04 14:46:50 +00:00
rollup.config.js Fix rollup warnings 2019-07-19 00:11:29 +01:00
settings.default.toml Add short-term caching header to list-devices and list-devices-near. 2019-10-10 21:25:40 +01:00
version Bugfix: Fix error in list-devices-near error 2020-03-05 18:52:53 +00:00

README.md

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

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.