henry-ns/canary

System for monitoring air quality

Canary

Description   |    Getting Started   |    What's inside?   |    License

📋 Description

Canary is a system for monitoring air quality information through the device that can capture aspects such as air temperature, air humidity and concentration of some gases (currently CO, CO2 and NH3) in the ambient.

this project was created to compete on the 7th Campus Mobile and we achieved to be one of the finalists in the smart cities category as "Projeto Desenvolvendo um dispositivo de monitoramento da qualidade do ar conectado a smartphones".

🚀 Getting Started

1. Download the repository

• Using Git

  git clone https://github.com/henry-ns/canary.git

• Using Github CLI

  gh repo clone henry-ns/canary

💡 or whichever way you prefer

2. Installation

Use Yarn ou NPM for install all dependencies for the server and the mobile app. Inside the current folder (server or mobile) execute the follows commands:

  yarn
  yarn start

or

  npm install
  npm start

For the hardware, you need to have a NodeMCU for instalation inside it. Considering you have this:

1. Download the Arduino IDE
2. Install ESP8266 board
3. Install all dependencies:
   • ESP8266HTTPUpdateServer
   • ESP8266WebServer
   • ESP8266WiFi
   • WiFiClient
   • DHT
4. Update the hardware with the code.

🧐 What's inside?

🏗️ Technologies

• Arduino: for programing the embedded system
• React Native: for mobile app
• Node.js: for server
• NodeMCU: the embedded system
• PostgreSQL: for database

📦 Packages on mobile

• Axios
• React Native Material Dropdown
• React Native Orientation
• React Native Picker Select
• React Native Smart Button
• React Native Vector Icons
• React Navigation

📦 Packages on server

• Bcrypt
• Consign
• Express
• JWT Simple
• Knex
• Passport
• Nodemon

📝 License

This project is under the MIT license. See the file LICENSE for more details.

---

Build with 💙 By Henrique Miranda, Gabriel Barros, and David Luna