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 measur route reporting productivity simulator optimize parallelism observability compose
Last synced: about 23 hours ago
JSON representation
Repository metadata
This repo contains API definitions for the AirQo platform
- Host: GitHub
- URL: https://github.com/airqo-platform/airqo-api
- Owner: airqo-platform
- License: mit
- Created: 2019-06-22T13:06:28.000Z (almost 6 years ago)
- Default Branch: staging
- Last Pushed: 2025-04-24T07:42:52.000Z (3 days ago)
- Last Synced: 2025-04-24T12:02:12.298Z (3 days ago)
- Topics: hacktoberfest, hacktoberfest2024
- Language: JavaScript
- Homepage: https://airqo.africa/
- Size: 107 MB
- Stars: 24
- Watchers: 4
- Forks: 23
- Open Issues: 114
- Releases: 0
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
README.md
AirQo-api
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
│ ├── access-control
│ ├── analytics
│ ├── argo-cd
│ ├── auth-service
│ ├── calibrate
│ ├── cilium
│ ├── data-mgt
│ ├── device-monitor
│ ├── device-registry
│ ├── device-status
│ ├── device-uptime
│ ├── exceedance
│ ├── gp-model
│ ├── grafana
│ ├── incentives
│ ├── insights
│ ├── jenkins
│ ├── kafka
│ ├── locate
│ ├── meta-data
│ ├── mlflow
│ ├── namespaces
│ ├── new-relic
│ ├── nginx
│ ├── nodes
│ ├── predict
│ ├── redis
│ ├── spatial
│ ├── streams
│ ├── view
│ ├── website
│ └── workflows
└── src
├── analytics
├── auth-service
├── blog-content-manager
├── calibrate
├── data-mgt
├── data-proxy
├── device-monitoring
├── device-registry
├── device-status
├── device-uptime
├── exceedances
├── firebase
├── gp-model
├── incentives
├── insights
├── kafka-connectors
├── locate
├── meta-data
├── 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
-
Running locally with “Docker for Desktop” You will build and deploy microservices images to a single-node Kubernetes cluster running on your development machine.
-
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
- Name: AirQo Platform
- Login: airqo-platform
- Email: [email protected]
- Kind: organization
- Description: At AirQo, we develop hardware and software tools to help deliver Clean Air for All African Cities
- Website: http://www.airqo.net
- Location: Kampala, Uganda
- Twitter: AirQoProject
- Company:
- Icon url: https://avatars.githubusercontent.com/u/52103247?v=4
- Repositories: 3
- Last ynced at: 2023-03-03T21:25:12.602Z
- Profile URL: https://github.com/airqo-platform
GitHub Events
Total
- Create event: 359
- Issues event: 59
- Watch event: 2
- Delete event: 379
- Issue comment event: 1855
- Push event: 4581
- Gollum event: 9
- Pull request review comment event: 1262
- Pull request event: 1824
- Pull request review event: 1149
- Fork event: 3
Last Year
- Create event: 359
- Issues event: 59
- Watch event: 2
- Delete event: 379
- Issue comment event: 1855
- Push event: 4581
- Gollum event: 9
- Pull request review comment event: 1262
- Pull request event: 1824
- Pull request review event: 1149
- Fork event: 3
Committers metadata
Last synced: 6 days ago
Total Commits: 20,524
Total Committers: 36
Avg Commits per committer: 570.111
Development Distribution Score (DDS): 0.489
Commits in past year: 7,215
Committers in past year: 13
Avg Commits per committer in past year: 555.0
Development Distribution Score (DDS) in past year: 0.242
| Name | Commits | |
|---|---|---|
| github-actions[bot] | 4****] | 10482 |
| baalmart | b****t@g****m | 3842 |
| Mike Mwanje | m****7@g****m | 784 |
| GitHub Actions | a****s@g****m | 759 |
| Noah Nsimbe | 3****e | 701 |
| NicholasTurner23 | m****e@g****m | 590 |
| 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 | 353 |
| ja-odur | o****8@g****m | 267 |
| lilly-muyama | m****n@g****m | 180 |
| wabinyai | r****o@g****m | 157 |
| Kyazike Samantha Gloria | g****e@g****m | 117 |
| Sserunjogi Richard | s****h@g****m | 82 |
| Ochieng Paul | o****2@g****m | 79 |
| AnthonyByansi | b****y@g****m | 55 |
| Kisakye-e | e****e@g****m | 38 |
| 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 |
| A7med7x7 | a****7@g****m | 3 |
| Turner | t****r@T****l | 2 |
| and 6 more... | ||
Committer domains:
- mac1-desktop.localdomain: 1
- inglt08182.deusto.es: 1
- sheffield.ac.uk: 1
- aimsammi.com: 1
- airqo.net: 1
- github.com: 1
Issue and Pull Request metadata
Last synced: 2 days ago
Total issues: 262
Total pull requests: 2,699
Average time to close issues: over 3 years
Average time to close pull requests: 2 days
Total issue authors: 6
Total pull request authors: 21
Average comments per issue: 0.2
Average comments per pull request: 1.93
Merged pull request: 2,556
Bot issues: 132
Bot pull requests: 0
Past year issues: 132
Past year pull requests: 1,934
Past year average time to close issues: about 1 hour
Past year average time to close pull requests: 1 day
Past year issue authors: 1
Past year pull request authors: 14
Past year average comments per issue: 0.0
Past year average comments per pull request: 2.07
Past year merged pull request: 1,853
Past year bot issues: 132
Past year bot pull requests: 0
Top Issue Authors
- coderabbitai[bot] (132)
- Baalmart (114)
- sserurich (8)
- ja-odur (4)
- noahnsimbe (3)
- Codebmk (1)
Top Pull Request Authors
- Baalmart (2,032)
- NicholasTurner23 (301)
- BenjaminSsempala (132)
- wabinyai (53)
- Mnoble-19 (50)
- Psalmz777 (44)
- OchiengPaul442 (37)
- MartinKalema (15)
- AnthonyByansi (10)
- Kisakye-e (4)
- sserurich (3)
- petermark23 (3)
- karam-ellhaj (3)
- noahnsimbe (2)
- 123MwanjeMike (2)
Top Issue Labels
- priority-medium (21)
- priority-high (14)
- feature-request (14)
- enhancement (12)
- bug (8)
- hotfix (8)
- events (6)
- k8s (6)
- priority-low (4)
- data-engineering (4)
- technical-debt (4)
- packages (2)
- chore (2)
- modules (2)
- activities (2)
- ml-ops (2)
- documentation (2)
- resolved (2)
- hardware (2)
- refactoring (2)
- invalid (1)
Top Pull Request Labels
- ready for review (2,235)
- work in progress (64)
- data-engineering (27)
- priority-high (18)
- auth-service (11)
- device-registry (10)
- priority-medium (10)
- hotfix (9)
- k8s (4)
- data-mgt (4)
- On-Hold (3)
- bug (3)
- priority-low (2)
- enhancement (2)
- python (2)
- mobile-app (2)
- refactoring (1)
- predict (1)
- fault-detection (1)
- incentives (1)
- documentation (1)
- invalid (1)
- chore (1)
Dependencies
- actions/checkout v3 composite
- github/codeql-action/analyze v1 composite
- github/codeql-action/autobuild v1 composite
- github/codeql-action/init v1 composite
- 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
- 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
- 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
- ASzc/change-string-case-action v2 composite
- actions/checkout v3 composite
- google-github-actions/auth v0 composite
- google-github-actions/setup-gcloud v0 composite
- actions/checkout v3 composite
- actions/setup-java v3 composite
- dorny/test-reporter v1.6.0 composite
- confluentinc/cp-schema-registry latest build
Score: 8.510772623613315