UniFinder is a web application that helps users discover information about various amenities and services in the local area around Integral university campus. Whether you're a freshman looking for the best places to eat or a first-year student in search of nearby hostels, UniFinder provides you with a single platform to access essential information.
- Discover nearby restaurants, hostels, mess halls, shops, and more.
- Explore detailed information and descriptions for each establishment.
- Easily locate and access services in the university's vicinity.
- Conveniently categorized sections for various amenities.
- [Future Feature]: User reviews and ratings for added convenience.
Follow these instructions to get UniFinder up and running on your local machine.
- Node.js and npm (Node Package Manager) installed.
- A modern web browser.
-
Clone the repository:
git clone https://github.com/khubaibkm/UniFinder.git
-
Navigate to the project directory:
cd UniFinder -
Install the required dependencies:
npm install
-
Start the development server:
npm run dev
The app should now be running on http://localhost:3000.
- Visit the UniFinder website in your web browser.
- Use the navigation menu to explore different sections (e.g., Restaurants, Hostels, Mess Halls).
- Click on a specific establishment to view detailed information
- We welcome contributions from the community. If you'd like to contribute to UniFinder, please follow our Contributing Guidelines as follows:
- Fork the Repository.
- After making changes, make a pull request.
- After your request got accepted, you will be counted as a contributor to UniFinder.
-
We would like to express our gratitude to the open-source community for their invaluable contributions and support.
Thank You !