Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

AirQo

Develop hardware and software tools to help deliver Clean Air for All African Cities.
https://github.com/airqo-platform/airqo-api

Category: Natural Resources
Sub Category: Air Quality

Keywords

hacktoberfest hacktoberfest2024

Keywords from Contributors

transformers standards measurements interpretation reporting route optimizers parallelism composibility conversion

Last synced: about 11 hours ago
JSON representation

Repository metadata

This repo contains API definitions for the AirQo platform

README.md

AirQo-api

deploy-apis-to-production deploy-apis-to-staging run-tests

What is AirQo??

The AirQo project aims to measure and quantify the scale of air pollution in and around African cities 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.

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.

Folder Organisation

.
├── LICENSE
├── README.md
├── codecov.yml
├── contributing.md
├── docs
│   ├── img
│   └── system-architecture.md
├── infra
│   ├── ansible
│   └── terraform
├── k8s
│   ├── analytics
│   ├── workflows
│   ├── auth-service
│   ├── calibrate
│   ├── cilium
│   └── *
├── packages
│   ├── airqo-icons
│   └── *
└── src
    ├── analytics
    ├── auth-service
    ├── device-registry
    ├── predict
    ├── spatial
    ├── view
    ├── website
    ├── workflows
    └── *

Features

  • Multi-protocol connectivity (HTTP and MQTT)
  • Device management
  • Access control
  • Incentives
  • 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.

Deployment

To deploy on the AirQo platform
cd AirQo-api/src/microservice-name

Build the image
docker build -t eu.gcr.io/gcp-project-name/microservice-name .

Run the container based on newly created image
docker run -d -n best -p host-port:container-port eu.gcr.io/gcp-project-name/microservice-name

The flags for running the container

  • p (publish)
    Asks Docker to forward traffic incoming on the host’s port host-port to the container’s port container-port. Containers have their own private set of ports, so if you want to reach one from the network, you have to forward traffic to it in this way. Otherwise, firewall rules will prevent all network traffic from reaching your container, as a default security posture.
  • d (detach)
    asks Docker to run this container in the background.
  • n (name)
    name you can use to specify the newly created container in subsequent commands. Above examples has the name as best.

Visit the application in REST client or Web browser
localhost:host-port. You should the application up and running. Now would be the time to run unit tests, for example:

delete container after successful unit tests
docker rm --force best.

Share images on DockerHub or Google Container Registry
docker push //

  • Example: docker push eu.gcr.io/airqo-api/airqo-device-registry-api

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.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 3 days ago

Total Commits: 26,463
Total Committers: 38
Avg Commits per committer: 696.395
Development Distribution Score (DDS): 0.479

Commits in past year: 6,006
Committers in past year: 9
Avg Commits per committer in past year: 667.333
Development Distribution Score (DDS) in past year: 0.442

Name Email Commits
github-actions[bot] 4****] 13782
baalmart b****t@g****m 5495
NicholasTurner23 m****e@g****m 1210
Mike Mwanje m****7@g****m 784
GitHub Actions a****s@g****m 759
Noah Nsimbe 3****e 701
Noah Nsimbe n****h@g****m 523
Mutabazi Noble 6****9 505
danielogen d****n@g****m 437
Priscilla-AL p****a@a****t 427
Benjamin Ssempala 8****a 372
wabinyai r****o@g****m 290
ja-odur o****8@g****m 267
Kyazike Samantha Gloria g****e@g****m 180
lilly-muyama m****n@g****m 180
Ochieng Paul o****2@g****m 159
Sserunjogi Richard s****h@g****m 82
AnthonyByansi b****y@g****m 55
Kisakye-e e****e@g****m 38
kasasa22 k****5@g****m 36
OlukaGibson g****7@g****m 35
fajemila f****d@g****m 26
MartinKalema k****a@g****m 23
balmart b****t@b****l 22
Usman Abdulganiy Babatunde a****n@a****m 22
dependabot[bot] 4****] 11
paul o****l@y****m 11
bobturneruk r****r@s****k 10
Abdul-Ganiy Usman 3****5 5
petermark23 m****s@g****m 4
and 8 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 21 days ago

Total issues: 207
Total pull requests: 4,376
Average time to close issues: over 2 years
Average time to close pull requests: 2 days
Total issue authors: 11
Total pull request authors: 24
Average comments per issue: 0.35
Average comments per pull request: 1.83
Merged pull request: 3,881
Bot issues: 107
Bot pull requests: 0

Past year issues: 16
Past year pull requests: 922
Past year average time to close issues: 15 minutes
Past year average time to close pull requests: about 12 hours
Past year issue authors: 3
Past year pull request authors: 7
Past year average comments per issue: 0.31
Past year average comments per pull request: 1.94
Past year merged pull request: 724
Past year bot issues: 8
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/airqo-platform/airqo-api

Top Issue Authors

  • coderabbitai[bot] (107)
  • Baalmart (82)
  • NicholasTurner23 (5)
  • sserurich (4)
  • noahnsimbe (2)
  • ja-odur (2)
  • chad5150 (1)
  • OchiengPaul442 (1)
  • Codebmk (1)
  • BenjaminSsempala (1)
  • Psalmz777 (1)

Top Pull Request Authors

  • Baalmart (3,350)
  • NicholasTurner23 (472)
  • BenjaminSsempala (192)
  • wabinyai (111)
  • Mnoble-19 (74)
  • Psalmz777 (65)
  • OchiengPaul442 (52)
  • MartinKalema (22)
  • AnthonyByansi (15)
  • kasasa22 (6)
  • karam-ellhaj (5)
  • 123MwanjeMike (3)
  • pronapro (3)
  • A7med7x7 (2)
  • petermark23 (2)

Top Issue Labels

  • ready for review (24)
  • priority-medium (11)
  • feature-request (7)
  • priority-high (7)
  • enhancement (6)
  • bug (4)
  • hotfix (4)
  • k8s (3)
  • events (3)
  • data-engineering (2)
  • priority-low (2)
  • technical-debt (2)
  • testing (1)
  • device-registry (1)
  • good first issue (1)
  • chore (1)
  • activities (1)
  • hardware (1)
  • work in progress (1)
  • refactoring (1)
  • resolved (1)
  • documentation (1)
  • ml-ops (1)
  • invalid (1)
  • packages (1)
  • modules (1)

Top Pull Request Labels

  • ready for review (3,610)
  • work in progress (112)
  • data-engineering (40)
  • priority-high (31)
  • auth-service (22)
  • device-registry (21)
  • priority-medium (18)
  • hotfix (13)
  • k8s (4)
  • bug (4)
  • priority-low (4)
  • documentation (4)
  • predict (3)
  • python (3)
  • data-mgt (3)
  • incentives (2)
  • On-Hold (2)
  • refactoring (2)
  • devops (2)
  • chore (1)
  • invalid (1)
  • fault-detection (1)
  • enhancement (1)
  • mobile-app (1)

Package metadata

pypi.org: airqoair

Openair-inspired Python tools for air quality analysis, visualisation, and mapping

  • Homepage: https://github.com/airqo-platform/AirQo-api
  • Documentation: https://airqoair-project.github.io/book
  • Licenses: MIT
  • Latest release: 0.1.1 (published about 1 month ago)
  • Last Synced: 2026-03-29T19:09:36.366Z (20 days ago)
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 232 Last month
  • Rankings:
    • Dependent packages count: 7.655%
    • Downloads: 20.603%
    • Average: 23.847%
    • Dependent repos count: 43.284%
  • Maintainers (1)
pypi.org: airqosm

Air pollution source metadata client, inference engine, and optional API

  • Homepage: https://github.com/airqo-platform/AirQo-api
  • Documentation: https://airqosm.readthedocs.io/
  • Licenses: MIT
  • Latest release: 0.2.3 (published about 1 month ago)
  • Last Synced: 2026-03-29T19:09:41.589Z (20 days ago)
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 345 Last month
  • Rankings:
    • Dependent packages count: 7.743%
    • Downloads: 21.357%
    • Average: 24.294%
    • Dependent repos count: 43.782%
  • Maintainers (1)
pub.dev: airqo_icons_flutter

Universal Flutter icon widgets with comprehensive framework support and Aq prefix naming

  • Homepage: https://airqo.net/packages
  • Documentation: https://pub.dev/documentation/airqo_icons_flutter/
  • Licenses: mit
  • Latest release: 1.0.4 (published 26 days ago)
  • Last Synced: 2026-03-29T19:10:06.493Z (20 days ago)
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 16.532%
    • Average: 27.214%
    • Dependent repos count: 37.895%
npmjs.org: @airqo-packages/network-coverage

Node.js client for the AirQo Network Coverage API — typed wrappers for all monitor and registry endpoints

  • Homepage: https://github.com/airqo-platform/AirQo-api/tree/staging/packages/airqo-network-coverage#readme
  • Licenses: MIT
  • Latest release: 2.0.0 (published 23 days ago)
  • Last Synced: 2026-03-29T19:10:29.012Z (20 days ago)
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent repos count: 22.304%
    • Average: 27.227%
    • Dependent packages count: 32.149%
  • Maintainers (1)
npmjs.org: @airqo/icons-vue

Production-ready Vue icon library with 1,383+ TypeScript components and tree-shakable imports

  • Homepage: https://airqo.net/packages
  • Licenses: MIT
  • Latest release: 0.2.5 (published 26 days ago)
  • Last Synced: 2026-03-29T19:09:17.501Z (20 days ago)
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 116 Last month
  • Rankings:
    • Dependent repos count: 24.106%
    • Average: 29.444%
    • Dependent packages count: 34.781%
  • Maintainers (2)
npmjs.org: @airqo/icons-react

Production-ready React icon library with 1,383+ TypeScript components and tree-shakable imports

  • Homepage: https://airqo.net/packages
  • Licenses: MIT
  • Latest release: 1.0.0 (published 9 months ago)
  • Last Synced: 2026-03-29T19:09:57.355Z (20 days ago)
  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 679 Last month
  • Rankings:
    • Dependent repos count: 24.164%
    • Average: 29.515%
    • Dependent packages count: 34.866%
  • Maintainers (2)

Dependencies

.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite
.github/workflows/deploy-apis-to-production.yml actions
  • Wandalen/wretry.action master composite
  • actions/checkout v3 composite
  • azure/k8s-set-context v2 composite
  • docker/build-push-action v3 composite
  • docker/login-action v2 composite
  • docker/setup-buildx-action v1 composite
  • docker/setup-qemu-action v1 composite
  • fjogeleit/yaml-update-action main composite
  • google-github-actions/auth v0 composite
  • google-github-actions/setup-gcloud v0 composite
.github/workflows/deploy-apis-to-staging.yml actions
  • Wandalen/wretry.action master composite
  • actions/checkout v3 composite
  • azure/k8s-set-context v2 composite
  • docker/build-push-action v3 composite
  • docker/login-action v2 composite
  • docker/setup-buildx-action v1 composite
  • docker/setup-qemu-action v1 composite
  • fjogeleit/yaml-update-action main composite
  • google-github-actions/auth v0 composite
  • google-github-actions/setup-gcloud v0 composite
.github/workflows/deploy-previews.yml actions
  • ASzc/change-string-case-action v2 composite
  • actions/checkout v3 composite
  • actions/github-script v6 composite
  • docker/login-action v2 composite
  • google-github-actions/auth v0 composite
  • google-github-actions/setup-gcloud v0 composite
.github/workflows/remove-deploy-previews.yml actions
  • ASzc/change-string-case-action v2 composite
  • actions/checkout v3 composite
  • google-github-actions/auth v0 composite
  • google-github-actions/setup-gcloud v0 composite
.github/workflows/test-changes.yml actions
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
  • dorny/test-reporter v1.6.0 composite
k8s/schemas/Dockerfile docker
  • confluentinc/cp-schema-registry latest build

Score: 15.881802015034598