https://github.com/vishalyadav0987/pg-finder

PG-Finder is a full-stack web application built using the MERN stack (MongoDB, Express.js, React.js, Node.js) that helps users find paying guest accommodations. The application provides various features to facilitate property listing, booking, and reservation management.
https://github.com/vishalyadav0987/pg-finder

expressjs mongodb nodejs reactjs redux-toolkit scss-framework scss-mixins scss-modules

Last synced: 9 days ago
JSON representation

PG-Finder is a full-stack web application built using the MERN stack (MongoDB, Express.js, React.js, Node.js) that helps users find paying guest accommodations. The application provides various features to facilitate property listing, booking, and reservation management.

• Host: GitHub
• URL: https://github.com/vishalyadav0987/pg-finder
• Owner: vishalyadav0987
• Created: 2024-04-25T07:19:18.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-07-22T05:52:48.000Z (3 months ago)
• Last Synced: 2024-09-26T00:41:06.199Z (9 days ago)
• Topics: expressjs, mongodb, nodejs, reactjs, redux-toolkit, scss-framework, scss-mixins, scss-modules
• Language: JavaScript
• Homepage:
• Size: 25.8 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🏠 PG-Finder

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Node Version](https://img.shields.io/badge/node.js-14.x%20|%2016.x%20|%2018.x-brightgreen)](https://nodejs.org/en/download/)

 

    

  

## Welcome to PG-Finder - Your Ultimate Solution for Finding Paying Guest Accommodations!.

## Installation

1. *Clone the repository*:

    ``` bash

    git clone https://github.com/vishalyadav0987/PG-Finder.git

    cd cd PG-Finder

    ```

2. *Install backend dependencies*:

    ``` bash

    cd server

    npm install

    ```

3. *Install frontend dependencies*:

    ```bash

    cd ../frontend/pg-frontend

    npm install

    ```

4. *Start the development servers*:

    - Backend server:

      ```bash

      cd ../server

      npm start

      ```

    - Frontend server:

      ```bash

      cd ../frontend/pg-frontend

      npm run dev

      ```

## Usage

1. Open your browser and navigate to http://localhost:5173 to access the frontend.

2. Use Postman or any API client to interact with the backend via http://localhost:3000.

## 📋 Features

* Property Listing: List your properties with ease, including details like location, amenities, and pricing.

* Property Search: Search for accommodations based on location, price range, and amenities.

* Booking Management: Manage your bookings and reservations effortlessly.

* Trip List: Keep track of your booked accommodations and upcoming stays.

* Secure Authentication: User authentication ensures secure access to features.

## 🛠️ Technology Stack

* Frontend: React.js

* Backend: Node.js, Express.js

* Database: MongoDB

* Authentication: JWT (JSON Web Tokens)

## 🚧 Future Enhancements

* Real-time updates listing property

* Social login options for authentication.

## Contributing

- Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

## License

- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgements

- Inspired by various open-source projects and the MERN stack community.

## Contact

- For any inquiries or feedback, please contact [[email protected]].