Skip to content

This repo contains API definitions for the AirQo platform

Notifications You must be signed in to change notification settings

danielogen/AirQo-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AirQo-api

BCH compliance Build Status codecovCodacy Badge

What is AirQo?

The AirQo project aims to measure and quantify the scale of air pollution in and around Kampala City through the design, development and deployment of a network of low-cost air quality sensing devices mounted on either static or mobile objects.

System Architecture

AirQo platform is composed of many microservices written in different languages that talk to each other using Istio.

Architecture of microservices

The AirQo system architecture uses a mono repo for faster shipping. Each service has its own database. Consistency across these databases is maintained using an event driven approach. There is also an API gateway (Nginx) which clients use to access ther rest of the services. The state of the miscroservices is monitored using PM2. Deployment pattern is one service per container using Docker.

Service Language Description
analytics-service Flask/Python & MongoDB This is the one to be used for all analytics work
app-enable-service Node.js To enable any application that consumes the services of this platform.
auth-service Node.js Authentication services for this endpoint
data-mgt-service Flask/Python & MongoDB A fully-managed service for transforming/processing and enriching data in stream (real time) and batch (historical) modes with equal reliability and expressiveness
device-registry-service . Node.js Carry out the management of the devices
incetives-service Node.js The payment service to incetivise various stakeholders
ml-service Flask/Python & MongoDB The machine learning models for predictions and forecasts
monitoring-service Node.js Monitoring the health of all the microservices
noitification-service Node.js Takes care of all the notification needs of the application.

Features

  • Multi-protocol connectivity (HTTP and MQTT)
  • Device management
  • Access control
  • Incetives
  • Message persistence (MongoDB and PostgresSQL)
  • Container-based deployment using Docker and Kubernetes
  • Microservices architecture, high-quality code and test coverage

Installation and Usage

  1. Running locally with “Docker for Desktop” You will build and deploy microservices images to a single-node Kubernetes cluster running on your development machine.

  2. Running on Google Compute Engine (GCE)” You will build, upload and deploy the container images to a Kubernetes cluster on Google Cloud Engine.

Contributing

We invite you to help us build this platform. Please look up the contributing guide for details.

Issues

Before reporting a problem, please check out the issue guide.

About

This repo contains API definitions for the AirQo platform

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 95.8%
  • Python 3.5%
  • Other 0.7%