Welcome to the Hostel and PG Finder project! 🎉
In India, finding affordable and comfortable accommodation can be a daunting task, especially for students pursuing their studies. Our mission is to simplify this process by creating a dedicated platform for students seeking hostels and Paying Guest (PG) accommodations across the country.
Hostel and PG Finder is a user-friendly web application designed specifically for students. Our platform allows users to search for and discover various hostel and PG options that fit their budget and preferences. With a focus on affordability, we aim to make student life easier and more comfortable.
- User -Friendly Interface: A clean and intuitive design that makes searching for accommodations easy.
- Search Functionality: Filter hostels and PGs based on price range to find options that suit your budget.
- Detailed Listings: Each listing includes essential information such as location, amenities, price, and ratings.
- Responsive Design: Accessible on various devices, ensuring that students can search for accommodations on the go.
- Community Driven: A platform that encourages users to share their experiences and reviews.
This project is built using the following technologies:
- Frontend: HTML, CSS, JavaScript
- Backend: Node.js, Express.js
- Database: MongoDB
- Version Control: Git
To run this project locally, follow these steps:
- Clone the repository:
git clone https://github.com/yourusername/Scholar.Shelter.git cd Scholar.Shelter
2.Install dependencies:
npm install
Express: A web framework for Node.js to build web applications.
npm install express
Mongoose: An ODM (Object Data Modeling) library for MongoDB and Node.js.
npm install mongoose
Cors: A package to enable Cross-Origin Resource Sharing, allowing your API to be accessed from different domains.
npm install cors
3.Set up the database: Ensure you have MongoDB installed and running. Create a database named hostels.
4.Run the server:
node server.js
5.Open your browser: Navigate to http://localhost:3000 to view the application.
We would like to acknowledge the following contributors for their efforts in making this project a success:
Feel free to reach out to them for any questions or collaboration!
We welcome contributions to make this project even better! If you'd like to contribute, please follow these steps:
Fork the repository. Create a new branch (git checkout -b feature/YourFeature). Make your changes and commit them (git commit -m 'Add some feature'). Push to the branch (git push origin feature/YourFeature). Open a Pull Request.
Contact
Contact
For any inquiries or feedback, feel free to reach out:
Email: [email protected]
GitHub: @Aerospace-prog
Thank you for checking out our project! Together, let's make finding student accommodations in India easier and more accessible! 🌟
Feel free to customize any sections, especially the contact information and the GitHub link, to reflect your personal or team details. This README provides a comprehensive overview of the project, its purpose, features, and how others can contribute.