| 🌟 Stars | 🍴 Forks | 🐛 Issues | 🔔 Pull Requests |
 |
 |
 |
 |
Urban areas face critical challenges like waste management inefficiency, traffic issues, and unsafe public spaces. At the same time, citizens often struggle to report such problems effectively. This leads to delayed resolutions, further deteriorating the environment and public well-being.
Shresta-City Insight aims to solve this by providing a platform for citizens to report civic issues like garbage on roads, traffic hazards, etc., ensuring timely action and reducing environmental impact.
Shresta-City Insight allows users to report issues, track resolutions, upload evidence (such as photos), and receive notifications about the progress of their complaints. It leverages Firebase for backend services, and Twilio for real-time SMS notifications, keeping users informed about their reports.
Check out the live demo of the platform Shresta City Insight
To get started with Shresta-City Insight 🚀, make sure you have Node.js and npm installed on your machine 💻.
-
To check this, you can type node -v and npm -v in the terminal.
-
Fork the repo 🍴 by clicking the fork button on GitHub and give it a name.
-
Clone it to your local machine using:
git clone https://github.com/yourusername/projectname.git
-
Navigate to the project directory:
cd projectname # Example: cd Shresta-city-insight
-
Install the dependencies 🔧:
npm install
-
Start the local server 🌍:
npm start
This will launch the development server at: 👉 http://localhost:3000/ 🖥️
- Civic Issue Reporting: Report issues with real-time tracking.
- Secure User Authentication and Authorization.
- OTP Authentication using Firebase for secure user verification.
- Real-time Notifications via SMS using Twilio.
- Scalable Infrastructure with Firebase services.
-
Citizen Workflow 👩🦰:
-
The user is required to register using their Google email ID (@gmail.com) for authentication and must provide the required details.📩
-
The user logs in using registered email Id and password.🔐
-
The user provides their location manually or allows it to be retrieved via an API. 📍
-
An OTP is sent to their registered mobile number for verification, which must be entered to proceed. 🔢
-
Upon successful verification, the user is redirected to the Complaint Submission Portal where they can report civic issues by uploading relevant images or documents. 📸📁
-
Alternatively, users can utilize voice input to lodge a complaint, which is transcribed into text via a Speech-to-Text API. 🎙️🗣️
-
After submitting the complaint, the user is navigated to the Thank you Page, where they have the option to provide feedback on their experience. ✍️
-
-
Officer Registration & Complaint Management Process 👮♂️📋
- Officers are required to register using an official email ID with the "@svecw.edu.in" domain, as this domain is exclusively designated for authorized personnel. ✉️✅
- Upon successful login, officers gain access to the Complaint Management Dashboard, where they can review all submitted complaints along with their corresponding images. 🖥️📸
- When an officer marks a complaint as resolved and selects the delete option, an automated notification is sent to the complainant via Twilio, informing them of the resolution. 📩🔔
The project aims to tackle social issues like waste management, civic improvements, and community-driven change.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.