From 1dce4c5e395b9209ae9f056d3906a834b0bfdeeb Mon Sep 17 00:00:00 2001 From: JaberDarawsheh Date: Fri, 8 Nov 2024 21:34:57 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c3d06e5..ab08658 100644 --- a/README.md +++ b/README.md @@ -1 +1,59 @@ -fathi +RentItOut: Peer-to-Peer Rental Platform for Everyday Items +RentItOut is a platform that allows users to rent everyday items they own but don’t use frequently, such as tools, electronics, and sports gear. This project focuses on building a backend RESTful API to power the platform. + +Features +Item Listings: Users can list and manage items for rent (tools, electronics, etc.). +Rental Management: Set rental durations, pricing, and flexible rental periods. +Trust & Safety: User verification, ratings, and security deposits. +Logistics: Location-based pickup and delivery options. +Revenue Model: Commission-based fees and optional damage protection. +Tech Stack +Backend: Node.js, Express.js +Database: MySQL +Authentication: JWT (JSON Web Tokens) +API Docs: Swagger +Other: Docker (for containerization), Google Maps API, Nodemailer (email service) +Getting Started +Prerequisites: +Node.js (v14+) +MySQL +Docker (optional) +Installation: +Clone the repository: +bash +Copy code +git clone https://github.com/malhaq/RetItOut +cd rentitout +Install dependencies: +bash +Copy code +npm install +Set up MySQL and create the database (rentitout). +Start the app: +bash +Copy code +npm start +API will be running on http://localhost:3000. + +API Documentation +API endpoints include: + +POST /api/items - Create a new listing +GET /api/items - Get all listings +PUT /api/items/{id} - Update a listing +DELETE /api/items/{id} - Delete a listing +Authentication: +Use JWT for secure login and role-based access control. + +Testing +Run tests with: + +bash +Copy code +npm run test +Contributing +Fork the repo. +Create a branch (git checkout -b feature-name). +Submit a pull request. +License +MIT License. See the LICENSE file for details. From 5f10b6bfbf27977f9dbc738fffd729feb3d93773 Mon Sep 17 00:00:00 2001 From: JaberDarawsheh Date: Fri, 8 Nov 2024 21:58:36 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 102 +++++++++++++++++++++++------------------------------- 1 file changed, 43 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index ab08658..2529bbd 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,43 @@ -RentItOut: Peer-to-Peer Rental Platform for Everyday Items -RentItOut is a platform that allows users to rent everyday items they own but don’t use frequently, such as tools, electronics, and sports gear. This project focuses on building a backend RESTful API to power the platform. - -Features -Item Listings: Users can list and manage items for rent (tools, electronics, etc.). -Rental Management: Set rental durations, pricing, and flexible rental periods. -Trust & Safety: User verification, ratings, and security deposits. -Logistics: Location-based pickup and delivery options. -Revenue Model: Commission-based fees and optional damage protection. -Tech Stack -Backend: Node.js, Express.js -Database: MySQL -Authentication: JWT (JSON Web Tokens) -API Docs: Swagger -Other: Docker (for containerization), Google Maps API, Nodemailer (email service) -Getting Started -Prerequisites: -Node.js (v14+) -MySQL -Docker (optional) -Installation: -Clone the repository: -bash -Copy code -git clone https://github.com/malhaq/RetItOut -cd rentitout -Install dependencies: -bash -Copy code -npm install -Set up MySQL and create the database (rentitout). -Start the app: -bash -Copy code -npm start -API will be running on http://localhost:3000. - -API Documentation -API endpoints include: - -POST /api/items - Create a new listing -GET /api/items - Get all listings -PUT /api/items/{id} - Update a listing -DELETE /api/items/{id} - Delete a listing -Authentication: -Use JWT for secure login and role-based access control. - -Testing -Run tests with: - -bash -Copy code -npm run test -Contributing -Fork the repo. -Create a branch (git checkout -b feature-name). -Submit a pull request. -License -MIT License. See the LICENSE file for details. +# RentItOut: Peer-to-Peer Rental Platform for Everyday Items + +**RentItOut** is a platform that allows users to rent everyday items they own but don’t use frequently, such as tools, electronics, and sports gear. This project focuses on building a **backend RESTful API** that powers the platform, making it easy for users to list, rent, and manage items. + +--- + +## Features + +- **Item Listings**: Users can list items they wish to rent out, including tools, electronics, sports equipment, etc. +- **Rental Management**: Manage rental durations, pricing, and flexible rental periods for each item. +- **Trust & Safety**: Implement user verification, item ratings, and security deposits to ensure a safe rental process. +- **Logistics**: Location-based options for pickup and delivery of items using integrated mapping services. +- **Revenue Model**: Platform generates revenue via commission-based fees, with optional damage protection. + +--- + +## Tech Stack + +- **Backend**: Node.js, Express.js +- **Database**: MongoDB +- **Authentication**: JWT (JSON Web Tokens) for secure login and authorization +- **API Documentation**: Postman and wiki for API documentation +- **External APIs**: Google Maps API (location-based services), Nodemailer (for email notifications) + +--- + +## Getting Started + +### Prerequisites + +To get this project up and running locally, you’ll need the following installed: + +- **Node.js** (v14 or higher) +- **MySQL** (for database management) +- **Docker** (optional, for containerized deployment) + +### Installation + + **Clone the repository**: + + ```bash + git clone https://github.com/malhaq/RentItOut.git + cd RentItOut From 2168ae307adb5a34cf6448683a95e69e70035a75 Mon Sep 17 00:00:00 2001 From: JaberDarawsheh Date: Fri, 8 Nov 2024 21:59:59 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 2529bbd..bfb63ba 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,7 @@ To get this project up and running locally, you’ll need the following installed: - **Node.js** (v14 or higher) -- **MySQL** (for database management) -- **Docker** (optional, for containerized deployment) +- **MongoDB** (for database management) ### Installation