https://github.com/haxcod/homerent
https://github.com/haxcod/homerent
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/haxcod/homerent
- Owner: haxcod
- Created: 2024-09-08T10:43:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-15T15:45:23.000Z (almost 2 years ago)
- Last Synced: 2025-01-22T07:37:43.348Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://home-rent-ten.vercel.app
- Size: 261 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Room Rent Management System
## Overview
The Room Rent Management System is a web application designed to help landlords and tenants manage room rentals efficiently. This application allows landlords to list available rooms, manage tenant information, track rental payments, and more. Tenants can view available rooms, make rental payments, and track their rental history.
## Features
- **Room Listings**: Landlords can add, update, and delete room listings.
- **Tenant Management**: Manage tenant details, including personal information and rental agreements.
- **Payment Tracking**: Track rental payments, including amounts due, paid, and overdue.
- **Search and Filter**: Search and filter rooms based on various criteria.
- **Dashboard**: View an overview of room occupancy, rental income, and pending payments.
## Installation
To set up the Room Rent Management System locally, follow these steps:
1. **Clone the Repository**:
```sh
git clone https://github.com/iamashishrathur/HomeRent.git
```
2. **Navigate to the Project Directory**:
```sh
cd HomeRent
```
3. **Install Dependencies**:
For the backend:
```sh
cd backend
npm install
```
For the frontend:
```sh
cd ../frontend
npm install
```
4. **Setup Environment Variables**:
Create a `.env` file in the `backend` directory and add the necessary environment variables:
```
DB_HOST=localhost
DB_USER=your-database-user
DB_PASSWORD=your-database-password
DB_NAME=room_rent_management
```
5. **Run Migrations**:
Run database migrations to set up the initial schema:
```sh
cd backend
npm run migrate
```
6. **Start the Application**:
Start the backend server:
```sh
npm start
```
In another terminal, start the frontend development server:
```sh
cd frontend
npm start
```
## Usage
1. **Access the Application**:
Open your browser and go to `http://localhost:3000` to access the Room Rent Management System.
2. **Landlord Features**:
- **Add Room**: Navigate to the "Rooms" section and click "Add Room" to create a new room listing.
- **Manage Tenants**: Go to the "Tenants" section to add or update tenant information.
- **Track Payments**: View and manage payment records in the "Payments" section.
3. **Tenant Features**:
- **View Rooms**: Browse available rooms and view details.
- **Make Payments**: Pay rent through the "Payments" section.
- **View Rental History**: Check your rental history and payment status.
## API Documentation
For detailed API documentation, refer to the [API Documentation](docs/API.md) file.
## Configuration
The Room Rent Management System includes configuration files for both the backend and frontend. Customize these files according to your environment and preferences.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For any questions or feedback, please contact [ashishrathaur3523@gmail.com](mailto:ashishrathaur3523@gmail.com).