Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saddickq/hommz
Hommz is a full stack web app that helps to bridge the gap between landlords and tenants(Airbnb clone)
https://github.com/saddickq/hommz
cloudinary expressjs javascript mongodb multer nodejs reactjs
Last synced: 6 days ago
JSON representation
Hommz is a full stack web app that helps to bridge the gap between landlords and tenants(Airbnb clone)
- Host: GitHub
- URL: https://github.com/saddickq/hommz
- Owner: Saddickq
- License: mit
- Created: 2024-07-06T16:58:03.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-18T22:59:15.000Z (7 months ago)
- Last Synced: 2024-12-04T19:33:09.382Z (2 months ago)
- Topics: cloudinary, expressjs, javascript, mongodb, multer, nodejs, reactjs
- Language: JavaScript
- Homepage: https://hommz.netlify.app/
- Size: 221 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://choosealicense.com/licenses/mit/)
# Hommz
Hommz is a comprehensive full stack web application designed to seamlessly connect landlords with potential tenants, serving as a modern solution akin to an Airbnb clone. The platform simplifies the rental process by offering an intuitive interface for landlords to list their properties and for tenants to search and book accommodations.
Hommz aims to enhance the rental experience for both parties. Whether you're a landlord looking to fill vacancies or a tenant in search of your next home, Hommz bridges the gap, making the rental process efficient and hassle-free.
## Features
- Responsive design
- User authentication
- User authorization
- Property Listings
- Booking and Reservations
- Dynamic Pricing
## Tech Stack
**Client:** React, Node, JavaScript
**Server:** Node, Express, JavaScript, MongoDB, Cloudinary, Multer
**Deployment:** Netlify, Render
## Installation
Clone the repository
```bash
git clone https://github.com/Saddickq/Hommz.git
```
Navigate into the project directory
```bash
cd Hommz
```
Install backend dependencies
```bash
cd server
npm install
```
Install frontend dependencies
```bash
cd ../client
npm install
```
Start the backend server
```bash
cd ../server
npm start
```
Start the frontend development server
```bash
cd ../client
npm start
```
#### Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`DB_URL`
`SECRET`
`PORT`
`NODE_ENV`
`cloud_name`
`api_key`
`api_secret`
## API References
#### Register
```http
POST /auth/register
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `email` | `string` | **Required**. Your email |
| `name` | `string` | **Required**. Your name |
| `password`| `string` | **Required**. Your password|
#### Login
```http
GET /auth/login
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `email` | `string` | **Required**. Your email |
| `password`| `string` | **Required**. Your password|
#### Logout
```http
GET /auth/logout
```
#### Create place
```http
POST /new_place
```
| Parameter | Type | Description |
| :----------- | :------- | :-------------------------------------------------- |
| `title` | `string` | **Required**. Title of the place |
| `description`| `string` | **Required**. Description of the place |
| `address` | `string` | **Required**. Address of the place |
| `price` | `number` | **Required**. Price per night |
| `photos` | `[string]`| **Required**. Array of photo URLs |
| `owner` | `string` | **Required**. User ID of the owner |
| `extraInfo` | `string` | **Optional**. Additional information about the place|
#### Get user Places
```http
GET /user_places
```
#### Get all available Places
```http
GET /places
```
#### Get Place
```http
GET /places/:id
```
| Parameter | Type | Description |
| :-------- | :------- | :--------------------------------- |
| `id` | `string` | **Required**. Id of place to fetch |
#### Update Place
```http
PUT /places/:id
```
| Parameter | Type | Description |
| :----------- | :------- | :-------------------------------------------------- |
| `title` | `string` | **Required**. Title of the place |
| `description`| `string` | **Required**. Description of the place |
| `address` | `string` | **Required**. Address of the place |
| `price` | `number` | **Required**. Price per night |
| `photos` | `[string]`| **Required**. Array of photo URLs |
| `extraInfo` | `string` | **Optional**. Additional information about the place|
#### Delete Place
```http
DELETE /places/:id
```
| Parameter | Type | Description |
| :-------- | :------- | :--------------------------------- |
| `id` | `string` | **Required**. Id of place to fetch |
#### Create Booking
```http
POST /bookings
```
| Parameter | Type | Description |
| :-------- | :-------- | :---------------------------------------------- |
| `checkIn` | `string` | **Required**. Time to check In |
| `checkOut`| `string` | **Required**. Time to check Out |
| `name` | `string` | **Required**. Name of person booking |
| `price` | `number` | **Required**. Price per night |
| `phone` | `string` | **Required**. phone number of the person booking|
| `place` | `string` | **Required**. Id of the place being booked |
| `user` | `string` | **Required**. Owner of the place |
#### Get Bookings
```http
GET /bookings
```
#### Delete Bookings
```http
DELETE /bookings/:id
```
## Authors
- [Saddickq](https://github.com/Saddickq)