Skip to content

Lazy-Sprinters/MuniciPal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation



MuniciPal - You Have A Voice !


Hackulus-MuniciPal

This is the official repository for team-Lazy Sprinters

Problem Statement

How often have you walked past a street in your locality and saw a pile of garbage that has been there for weeks? How often is it when you're driving and you encounter a pothole so deep it can lead to serious accidents? Or how about the sore sight that open drains provide apart from the health hazards?

Most of the times these things in your locality don't get noticed by the bodies of the system, the municipalities. Sometimes an RTI or sometimes a complaint letter needs to be sent to the Municipal Corporations to get these things sorted and in order. And we all know the time it takes for some action to be taken. So is this problem solvable?

Proposed Solution

Bridge the ultra-wide gap between municipalities and citizens of a particular area/locality/city. Bring transparency by providing the end-users visual references of the resolved complaint. Our product will enable the users to register hassle-free complaints using the app instead of the old school method of paperwork or registration of complaints at the municipality offices.

Tech Stack Used

Tools:

 Sublime Text
 Visual Studio Code
 Postman
 Android Studio
 Google Firbase Console

Languages:

 Javascript
 Kotlin

Frameworks:

 Reactjs
 Nodejs 

Implementation:

Video:

Presentation:

FRONTEND

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

BACKEND

TO RUN ON LOCAL MACHINE

npm run dev

Open http://localhost:5000 to view it in the browser.\

Setting Up .env

Create a .env file in the backend-root directory on your local machine with the following format
TEST_MAIL=(Mail ID for sending the cancellation messages and verifications emails)
TEST_PASS=(Password of the mail ID)
API_KEY=(API KEY for the HERE Platform)
SECRET=(Secret for the Vonage API service)
VKEY=(Key for the Vonage API service)
SERVICE=(Service of the mail ID as in Hotmail,Yahoo,Gmail etc)
AUTHSRT=(Token for the authentication service)

Setting Firebase

Create a firebase account and download SDKs for web and application.
Follow all the instructions to set up the firebase database step by step

APP (Android)

Link to APK

Process

Just install the APK and run it on your android phone.
When asked for OTP on SignUp use OTP=123456

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published