Air-Quality-Web/README.md

44 lines
1.9 KiB
Markdown
Raw Normal View History

2019-01-12 23:22:42 +00:00
# ConnectedHumber-Air-Quality-Interface
2019-01-17 14:31:09 +00:00
> The web interface and JSON api for the ConnectedHumber Air Quality Monitoring Project.
This project contains the web interface for the ConnectedHumber air Quality Monitoring system. It is composed of 2 parts:
2019-01-17 15:39:50 +00:00
- A PHP-based JSON API server (entry point: api.php) that's backed by a MariaDB server
2019-01-17 14:31:09 +00:00
- A Javascript client application that runs in the browser
The client-side browser application is powered by [Leaflet](https://leafletjs.com/).
2019-01-17 15:39:50 +00:00
Note that this project is _not_ responsible for entering data into the database. This project's purpose is simply to display the data.
2019-03-17 13:34:56 +00:00
## Documentation
Documentation has moved! You can view it here:
- https://aq.connectedhumber.org/__nightdocs/00-Welcome.html
2019-02-07 18:20:53 +00:00
2019-04-06 21:13:07 +00:00
## Branches
- `master`
- The default branch
- Should always be stable
- `dev`
- The development branch
- May not always be stable.
2019-01-17 14:31:09 +00:00
## Notes
- Readings are taken every 6 minutes as standard.
2019-01-19 21:12:11 +00:00
2019-01-17 14:38:32 +00:00
## Contributing
Contributions are welcome - feel free to [open an issue](https://github.com/ConnectedHumber/Air-Quality-Web/issues/new) or (even better) a [pull request](https://github.com/ConnectedHumber/Air-Quality-Web/compare).
The [issue tracker](https://github.com/ConnectedHumber/Air-Quality-Web/issues) is the place where all the tasks relating to the project are kept.
## Credits
2019-06-30 17:43:01 +00:00
- Map: [Leaflet.js](https://leafletjs.com/) showing [OpenStreetMaps](https://www.openstreetmap.org/) using various plugins
- Colour manipulation by [chroma.js](https://github.com/gka/chroma.js)
- Device graphs by [chart.js](https://www.chartjs.org)
- [Loading Animation](https://github.com/SamHerbert/SVG-Loaders)
## License
This project is licensed under the _Mozilla Public License 2.0_. The full text of this license can be found in the [LICENSE](https://github.com/ConnectedHumber/Air-Quality-Web/blob/master/LICENSE) file of this repository, along with a helpful summary of what you can and can't do provided by GitHub.