AstonAirQuality API

A Frontend React web app that serves as a management portal for Aston University's air quality sensor fleet. This project is part of a full stack web application designed for automated data ingestion from low-cost air quality sensors. It allows CRUD operations on sensor platforms and viewing of sensor data in an interactive map.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contact

About The Project

A Frontend React web application serving as a management interface for Aston University's air quality sensor fleet. This project is part of a comprehensive full stack web application, designed for automatic data intake from budget-friendly air quality sensors. It facilitates a GUI platform for creating, reading, updating, and deleting sensor platforms, scheduling data ingestion tasks, and reviewing intake logs and sensor data on an interactive map.

(back to top)

Built With

• 
• 
• 
• 

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Node.js and npm are required to run this project. You can download them from the official website.

Furthermore, you will need to have a Firebase project set up and configured. You can create a new Firebase project.

A Mapbox account is also required to use the map features. You can create a new Mapbox account.

And finally you will need a docker container running the backend API. You can find the backend API repository

Installation

1. Clone the repo

   git clone AstonAirQuality/AirQuality_Frontend

2. Install NPM packages

    npm install

3. Copy the env-template.txt file and rename it to .env and fill in the required fields.

   cp env.example .env

4. Run the project

    npm start

5. The project should now be running on localhost:3000

Contact

Twitter (X): @dev_riyad
Email: [email protected]
Project Link: https://github.com/AstonAirQuality/AirQuality-Frontend

(back to top)