https://github.com/mirsahib/project-whirlpool-backend
House Rental Management System REST API
https://github.com/mirsahib/project-whirlpool-backend
Last synced: 7 months ago
JSON representation
House Rental Management System REST API
- Host: GitHub
- URL: https://github.com/mirsahib/project-whirlpool-backend
- Owner: mirsahib
- Created: 2020-06-27T13:21:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T21:04:43.000Z (over 2 years ago)
- Last Synced: 2025-01-25T11:43:26.418Z (9 months ago)
- Language: PHP
- Homepage:
- Size: 390 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## House Rental Manegment System (HRMS) REST API
## Overview
The HRMS is an REST API to manage the tenant in my house.HRMS is build on laravel framework
## [HRMS front-end](https://github.com/mirsahib/Project-Whirlpool-frontend.git)
## Requirements
- Laravel 7
- Passport
- Composer
- Artisan
## Installation
[Read this document and follow the step carefully](https://devmarketer.io/learn/setup-laravel-project-cloned-github-com/)
Add this to your .env file
```
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=project-whirlpool
DB_USERNAME=root
DB_PASSWORD=
```
## Api
### HTTP requests
All API requests are made by sending a secure HTTPS request using one of the following methods, depending on the action being taken:
* `POST` Create a resource
* `PUT` Update a resource
* `GET` Get a resource or list of resources
* `DELETE` Delete a resource
### Houses
| Type | URL | Parameter | Body | Response | Description
| --- | --- | ---| --- | --- | --- |
| `GET` | `/api/houses` | **none** | **none** | return all houses
| `GET` | `/api/houses/{id}` | **id** - Identifier for current tenant | **none** | return specific house
| `POST` | `/api/houses/create` | **none** | | **none** | on successful response create new house
| `GET` | `/api/houses/{id}/edit` | **id** - Identifier for current house | **none** | return specific house
| `PUT/PATCH` | `/api/houses/{id}` | **id** - Identifier for current house | | none
| `DELETE` | `api/houses/{id}` | **id** - Identifier for current house | **none** | **none**
### Tenants
| Type | URL | Parameter | Body | Response | Description
| --- | --- | ---| --- | --- | --- |
| `GET` | `/api/tenants` | **none** | **none** | return all tenants
| `GET` | `/api/tenants/{id}` | **id** - Identifier for current tenant | **none** | return specific tenant
| `POST` | `/api/tenants/create` | **none** |
- name
- nid
- nid_img
- phone
- rent
- reg_date
| `GET` | `/api/tenants/{id}/edit` | **id** - Identifier for current tenant | **none** | return specific tenant
| `PUT/PATCH` | `/api/tenants/{id}` | **id** - Identifier for current tenant |
- name
- nid
- nid_img
- phone
- rent
- rent
- reg_date
| `DELETE` | `api/tenants/{id}` | **id** - Identifier for current tenant | **none** | **none**
### Payment
| Type | URL | Parameter | Body | Response | Description
| --- | --- | ---| --- | --- | --- |
| `GET` | `/api/payments` | **none** | **none** | return all paid and unpaid rent
| `POST` | `/api/payments/create` | **none** |
- month
- year
| `PUT/PATCH` | `api/payments/update/{id}` | **id** - Identifier for current payment | | |
## License
The HRMS API is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).