MOTORCYCLE RENTAL STORE

📗 Table of Contents

• 📗 Table of Contents
• 🛵[Booking Vespa API]
• 🛠 Built With
  • Tech Stack
  • Key Features
• 🚀 Live Demo
• 🧾 Database Structure
• 📄[Project Documentation]
• ✒ Kanban Board
• 🛠 Built With
• 💻 Getting Started
  • Prerequisites
  • Front end
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • Back end
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
• 👥 Authors / Team members
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgments
• 📝 License

Booking Motorcycle 🛵

This project is for reserving motorcycles. Whether you're gearing up for a special occasion or event and need a trendy scooter, or if you own a luxurious Vespa and want to earn extra income by renting it out, our website is your ideal destination.

Here are some key advantages of using our platform:

Extensive variety of vehicles available for your selection The primary functionalities of this website include:

- Providing users with comprehensive information about all available vi. - Enabling users to make reservations for a Vespa for their special occasions. - Allowing users to list their own Vespas for rent and manage their listings as needed.

🛠 Built With

Tech Stack

Client

Server

Database

Key Features

Login or register user:

• Create an account by providing a valid username and password.
• Once your account is created, you'll be automatically logged in and can access all of the app's features.

Trips:

• Once you're logged in, you can browse through a list of all available motorcycles.
• Get the details of a specific vespa/morotcycle by clicking on it. You can also reserve/book the selected vehicle from the details page.
• On the reserve page, fill out the information and reserve the best scooter in town! That's it. Congratulations!

Add/Delete:

• If you want to add a new vehicle, just click on the Add link in the navigation panel, and you'll be directed to a page where you can fill out a form to add a new vehicle.
• If you want to delete a vehicle, click on the Delete link in the navigation panel. You will be redirected to a page where you can see a list of all available vehicles from where you can delete some of them.

Reservations:

• To see all your reservations in one place, head to the My Reservations page. Here, you can see a list of all your reservations and get a glimpse of the details.

(back to top)

🚀 Live Demo

To see this project's live demo, please click here.

🧾 Database Structure:

Motorcycle Rentals Front End

Our frontend code is built using React and Redux and is hosted on a separate repository. The frontend handles the user interface and integrates with our backend API to retrieve and display data. Click the link below to get front end code

Motorcycle Rentals Back End

Our backend code is built using Ruby and Postgres database and is hosted on a separate repository from the frontend.Below you can find the link of the repository and you can see our database structure

📄 Project Documentation

Here you can find a detailed documentation for the API used in the project, including endpoints, request/response formats, and authentication methods. Developers can use this documentation to integrate our service into their applications and build custom integrations.

• Front-end GitHub repository link👈
• Back-end API link 👈
• API Documentation link 👈

✒ Kanban Board

We used a Kanban board to track the progress of tasks and issues. The board is designed to help visualize the status of work items, identify bottlenecks, and ensure that work is flowing smoothly.

Kanban Board link

Initial State

Final State

(back to top)

💻 Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

In order to run this project you need:

• Mac or PC
• Install node.js
• Use npm as package manager.
• Understanding of React and Redux

Front end

Setup

• Clone this repository to your desired folder: https://github.com/TamaraDimov/vespa-rentals-frontend.git

 git clone

• Navigate into the cloned folder

 cd vespa-rentals-frontend

Install

Install the project dependencies with:

  npm install

Usage

To run the project, execute the following command:

  npm start or npm s

Run tests

To run the tests, run the following command:

  npm test

Deployment

You can deploy this project using:

   npm run build

Back end

Setup

• Clone this repository to your desired folder: https://github.com/TamaraDimov/vespa-rentals-backend.git

 git clone

• Navigate into the cloned folder

 cd vespa-rentals-backend

Install

Install the project dependencies with:

  bundle install
  rails db:create
  rails db:migrate

• And Make sure to delete the Master key and credentials.yml.enc
• Here are the steps needed to create your own Credentials.
• Edit Open your terminal or command prompt.
• Navigate to the root directory of your Ruby on Rails application.

Run the following command:

rails credentials:edit command:

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

To run the tests, run the following command:

  rspec ./spec/models
  rspec ./spec/controllers

Deployment

You can deploy this project using:

  ./bin/dev

(back to top)

👥 Authors / Team members

👤 Tamara Dimov

• GitHub: @TamaraDimov
• LinkedIn: Tamara Dimov

👤 Kifle Haile

• GitHub: Kifle Haile
• Twitter: Kifle Haile
• LinkedIn: Kifle Haile

👤 Daniel Safari

• GitHub: Daniel Safari
• Twitter: Daniel Safari
• LinkedIn: Daniel Safari

👤 Besufekad Alemu

• GitHub: Besufekad Alemu
• LinkedIn: Besufekad Alemu

(back to top)

🚀 Future Features

• Integrate a rating feature to allow users give ratings to booked Vespas.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support

If you like this project, please give it a ⭐️ !

Acknowledgments

• Microverse

• We would like to thank Murat Korkmaz for the design guidelines.

📝 License

This project is MIT licensed.

(back to top)