Currently this dApp is deployed on Render as https://binlocator.onrender.com.
If you're planning to run this app locally, YOU MUST SETUP YOUR POSTGRESQL SERVER AND UPDATE URL IN .ENV FILE. OTHERWISE IT SIMPLY WON'T RUN. THE SCHEMA FOR DB TABLE IS IN QUERY FILE.
This is our Project for Submission in the Hackathon G-20 Sahastam Tech Fest- GBU
.
This is an app(web and android) which can help to locate dustbins in nearby area.
π Clone or fork this repo and change current directory to G-20 Sahastam Tech Fest- GBU
:
πΏ Install all dependencies:
cd G-20 Sahastam Tech Fest- GBU
npm install
β Rename .env.example
to .env
in the project folder and provide your SECRET-KEY
and DATABASE_URL
.
Example:
JWT_SECRET_KEY = xxxx-xxxx-xxxx-xxxx
π΄ββοΈ Run your App:
npm start
This App uses HTML
,CSS
and Javascript
at its core for frontend applications.
This App runs on and rendered by a Nodejs
server.
At the Backend
of this App , A Nodejs
server is running, which manages all the requests
and responses
from the user.
This App Uses Some Node_Modules in order to work properly which includes:
pg
- Connect to Database
- Perform DB queries
BCryptJS
- Encrypt Passwords before storing in DB
- Match Passwords on Login
jsonwebtoken
- Sign auth cookies
- Verify cookies on each request
- validate user login credentials
- set expiry on Login Cookies
Express
- create a web-server
- handles request and response
This app uses PostgreSQL
for all its database needs. This App uses DB to:
- Store User Information
- Implement Login, Signup and auth
- store dustbin locations
Currently this dApp is deployed on Render as https://binlocator.onrender.com.
There are some features which can be added in future:
- sorting of locations based on distance
- integrated directions
- etc.
This App uses cookies to store encrypted AuthToken, which is required for Authentication,
- Location permission is used to detect your location and show nearby dustbins.
- camera permissions is required for taking pictures while adding new bins.