My PG - A Paying Guest Management System - React Frontend

Welcome to the My PG Project! This project is the React-based frontend for the PG Management System, providing a user-friendly interface for landlords and tenants to manage and book paying guest accommodations.

Table of Contents

• Features
• Prerequisites
• Installation
• Usage
• Contributing
• License
• Contact

Features

• User Registration and Authentication
• Landlord Dashboard for Property Management
• Tenant Dashboard for Booking Management
• Search and Filter PG Properties
• Online Booking and Payment Integration
• Room Availability Tracking
• Reviews and Ratings System
• Responsive Design for Mobile and Desktop

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (version 18+)
• npm (version 11+) or Yarn

Installation

Follow these steps to set up the project on your local machine:

1. Clone the repository:

   git clone https://github.com/AfshanAlamEngg/mypg-frontend.git
   cd mypg-frontend

2. Install the required dependencies:

   npm install

   or

   yarn install

3. Configure the API endpoint in the .env file:

   REACT_APP_API_URL=http://localhost:8000/api

4. Start the development server:

   npm start

   or

   yarn start

Usage

After setting up the project, you can access the application by navigating to http://localhost:3000/ in your web browser. Use your credentials to log in and start managing your PG properties or booking accommodations.

Contributing

We welcome contributions! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Commit your changes (git commit -am 'Add your feature').
4. Push to the branch (git push origin feature/your-feature).
5. Create a new Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Contact

For any inquiries or support, please contact afshanalamengg@gmail.com