Pollunite

Small action today, Big impact tomorrow

Android Distribution · View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• 📔 Table of Contents
  • 🌟 About the Project
    • 🙈 Run Instantly
    • 👾 Tech Stack
    • 🎯 Features
    • 🎨 Color Reference
    • 🔑 Environment Variables
  • 🧰 Getting Started
    • ‼️ Prerequisites
    • ⚙️ Installation
    • 🏃 Run Locally
    • 🚩 Deployment
  • 👋 Contributing
  • ❔ Future Work
  • 🤝 Contact
  • 💎 Acknowledgements
  • 🎥 Demo

🌟 About the Project

🙈 Run Instantly

You would only need to download Expo Go from your phone (Android/iOS accepted) to scan the QR Code.

Then use Expo Go to scan the QR Code here. Type "[email protected]" as email and "123456" as password to get authenticated.

Voilà, Welcome to Pollunite. Please enjoy our app and tell us about your feelings !!

🎨 Color Reference

Color	Hex
Primary Color	#4CAF50
Secondary Color	#1D192B
Accent Color	#E8DEF8
Text Color	#EEEEEE

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

GOOGLE_API_KEY (https://developers.google.com/maps/documentation/javascript/get-api-key)

👾 Tech Stack

Client: React Native with TypeScript

• Typescript
• React Native
• TailwindCSS

Server & Database: Firebase Ecosystem

• Cloud Firestore
• Firebase Realtime Database
• Firebase Cloud Storage

🎯 Features

Pollution Map

GPS and Cluster Navigation

Pollution Report

View Area Detail

Area Resolutions

Event, Donations

Profile

🧰 Getting Started

‼️ Prerequisites

This project uses Node.js as the run-time environment for JavaScript/ TypeScript, and NPM as the package manager.\ Then you would need to install React Native for Expo

 npm install --global expo-cli

⚙️ Installation

Install Client-Side Services

  expo init frontend
  cd frontend

Since Firebase acts as Backend/ Database Management System in this project, we would not need to install anything further 😄

🏃 Run Locally

Clone the project

  git clone https://github.com/02david20/Pollunite

Go to the project directory

  cd Pollunite
  cd frontend

Install dependencies

  npm install

Start the server

  expo start

Then a QR code would be generated automatically in the CLI. If you have already installed Expo Go, you can scan the QR to run the application locally. Otherwise, you can run the project using AVD (Android Virtual Device).

🚩 Deployment

To deploy this project run

  expo publish

Expo CLI would subsequently create a site that links to the project's QR code. This time, anyone with Expo Go can run the app after scanning.

P/s: An Expo account is required to execute this step.

👋 Contributing

• Dai-Vinh Huynh
• Sang Kha
• Duc-An Nguyen
• Quang-Khanh Nguyen

❔ Future Work

• Notification For All People Subscribe in Area (Cluster)
• Sharing Environmental Achievement to Social Media
• Daily Reports
• Evaluate Impact of pollution the area
• Connect to digital waller service for donations

🤝 Contact

Huỳnh Đại Vinh - @facebook_handle

Project Link: https://github.com/02david20/Pollunite

💎 Acknowledgements

• Google Maps Platform API

• Firebase Documentation

• React Native with Expo

• Readme Template

🎥 Demo

To watch the full presentation, please visit our Youtube video

Pollution Map

Lu.ng.2x2.1.mp4

GPS and Cluster Navigation

Lu.ng.3x2.mp4

Pollution Report & Area Detail

Lu.ng.4x2.mp4

Area Resolutions

Lu.ng.5x2.mp4

Event, Donations

Lu.ng.6x2.mp4

Profile

Lu.ng.7x2.mp4