38 lines
1.6 KiB

# 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 air Quality Monitoring system. 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.
## 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.