Skip to content

Qais-Hweidi/Rent-It-Out

 
 

Repository files navigation

Table of Contents

Rent It Out

A Peer-to-Peer Rental Platform for Everyday Items.

Rent-It-Out is a rental platform where users can list items for rent, browse available items, and manage rental transactions.

It’s designed for individuals or businesses who want to rent out items in various categories and for people seeking short-term rentals instead of purchasing.

uml

Features

  • Item Listings
  • Rental Management
  • Trust & Safety
  • Logistics
  • Revenue & Insurance
  • Good User Experience
  • Reviews and Disputes
  • Admin
  • Test cases

Technologies Used

  • Node.js: Backend development platform.
  • MySQL: Database.
  • Sequelize: Promise-based Node.js ORM for database management.
  • Jest: JavaScript testing framework.
  • Supertest: High-level abstraction for testing HTTP
  • Postman: API building and documentation tool.
  • Git: Version control system.
  • Draw.io: UML drawing.
  • VScode: Our IDE.
  • XAMPP: Local server.
  • readme.so: To write this readme file

Run Locally

  • Clone the project:
  git clone https://github.com/mkittani/Rent-It-Out
  • Start Apache & MySQL using XAMPP (or any other alternative).

  • Open phpMyAdmin, then create a database and name it "rentitout".

  • Install dependencies:

  npm install
  • Start the server:
  npm run dev

API Documentation

The API is documented using Postman. You can access the full documentation here.

Authors

License

MIT

About

Peer-to-peer platform enabling seamless item rentals across diverse categories.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%