PG Finder is a web application that helps users find PGs and hostels in different states and cities. It provides a user-friendly interface to search and book accommodations based on location, price, and amenities. Built using Node.js, Express JS and MongoDB, PG Finder is easy to deploy and customize.
Live at : pg-finder-dart.onrender.com
The PG Finder application has been divided into 3 working modules, namely: Rider, Provider & Admin.
The rider module encompasses the user who is here to look for properties. A rider in the application can do several things enlisted below:
- Create a profile.
- Search for properties.
- Review, like and save properties for future.
- Book a property by paying the booking amount, using card payments.
- Get notified about booking success, booking fail, booking completion etc. through E-Mail.
- Finally, a user can see all their bookings & likes and other information at one place, Dashboard.
The provider module describes the user who is there to create property pages (their own), and do other stuff dealing with properties which they created. A provider's capabilities are:
- Create a profile
- Add properties by filling a detailed form, encompassing all details from property name to amenities provided.
- Delete or Update a property details.
- Confirm (Accept / Reject) a booking of a property owned by the provider after providing a valid message.
- Finally, a provider can see all his properties, past confirmed booking and current pending booking details on their dashboard.
As the name suggests, the admin has the complete control over the application. There are various tasks an admin can perform but PG Finder has taken care of the fact that multiple people can be admin, for this there is an entire admin-creation mechanism in place. Admin rights are as below:
- Create admin account by providing Email and Admin Key.
- Access the current state of all the roles in the application.
- See profiles of rider & provider and can delete them as per need.
- See status of all the bookings, and can remove any booking.
- Can see all the contact made through home page's contact us section.
To run the application on Local System, you need your node version to be 16.16.0 and above.
After installing node, clone the repository on your local system in a folder. Use following command:
git clone https://github.com/aryan-upa/pg-finder-v2.git
After this, go into the folder where you've cloned the repo to create a file called secret.env, for the required API
Keys follow guide environment-variables. Then open your fav shell and type:
npm init
npm start
Congratulations 🎉, you've successfully started the service on your local system.
The project is open for contribution, follow the contributing-guidelines to create meaningful contributions in the project.
MIT License - Copyright (c) 2023 Aryan Upadhyay & Priyanshi Mittal
Frontend Development: @priyanshi-mittal
Backend Development: @aryan-upa