nickemma / car-rental-api

Exotic Rentals API is a backend API for a car rental application. It allows users to create an account, login, and book a car for a specific period of time. It also allows users to view all available cars, and view a specific car. It also allows users to view all bookings made by a specific user.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Exotic Rentals API

Exotic Rentals API is a backend API for a car rental application. It allows users to create an account, login, and book a car for a specific period of time. It also allows users to view all available cars, and view a specific car. It also allows users to view all bookings made by a specific user.

Frontend

The frontend was made with react and can be found here

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• It allows users to create an account.
• It allows users to login.
• It allows users to book a car for a specific period of time.

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:NickEmma/car-rental-api.git

Install

Install this project with:

  cd car-rental-api
  bundle install

Usage

To run the project, execute the following command:

  rails db:create

  rails db:migrate

  rails db:seed

  rails server

Run tests

To run tests, run the following command:

  rspec spec/integration

Deployment

You can deploy this project using:

  git push heroku main

(back to top)

👥 Authors

👤 Nicholas Emmanuel

• GitHub: @NickEmma
• Twitter: @techieEmma
• LinkedIn: @Nicholas Emmanuel

👤 Abdelmejid Oumer Ali

• GitHub: @amejid
• Twitter: @amejidoumer
• LinkedIn: Abdelmejid Oumer Ali

👤 Said laasri

• GitHub: @Said-laasri
• Twitter: @saidlaasr
• LinkedIn: SAID LAASRI

👤 Abel Desalegn

• GitHub: @Abel-desu
• Twitter: @Abeldesalegn
• LinkedIn: Abel Desalegn

👤 Mohamed Ashour

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• It will allow users to rent a car.
• It will allows users to give a review for a specific car.

(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 consider giving it a star ⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me the opportunity to work on this project.

• LazyCoders
• Coding Partners
• Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)

car-rental-api's Issues

Backend Milestone #1: [2pt] Create Database design and setup

• create a UML diagram with a strong Database Structure.
• create migrations and relationships between the tables in the database according to the UML design.

Backend Milestone #3: [2pt] Set up authentication

• set up authentication with jwt.
• secure password with bycrpt

Frontend Milestone #2: [2pts] Create Navigation Panel

• In the navigation panel, the user can see links to:

• View all activities

• Reserve form.

• My reservations.

• Add activities (only visible to admin)

• Delete activities (only visible to admin)

Backend Milestone #8: [2pt] Integration testing

• Add integration tests for all core functionalities implemented for the reservations

Backend Milestone #2: [2pt] Project setup

• set up linters and all required gem files.

Final Milestone: Kanban Board

Project link here

Our collaboration consists of 5 members split into two main groups:

Front-End

@nickemma
@AACHOURMOHAMED

Back-End

@amejid
@Abel-desu
@Said-laasri

Points Per Coder

@amejid = 8.0
@AACHOURMOHAMED = 8.0
@nickemma = 8.0
@Abel-desu = 8.0
@Said-laasri = 8.0

Frontend Milestone #6: [2pts] Reserve Activity and My Reservations

• To reserve an appointment, the user has to select a date and city (username and selected item are auto-filled).
  • Use the design based on the ["Book a Vespa test-ride"] and add all necessary inputs.
  • The user can also access the "Reserve" page from the navigation panel. In that case, only the username is auto-filled.
• When the user clicks the "My reservations" link in the navigation panel they can see a list of their reservations (with information about item name, date, and city).

Frontend Milestone #5: [2pts] Add new and Delete activity form

• When the user clicks the "Add Item" link in the navigation panel they can see a form for adding a new item.
• When the user clicks the "Delete item" link in the navigation panel they can see a list of all items with titles and a "Delete" button.
• When the user clicks the "Delete" button, the selected item is marked as removed and does not show on the main list anymore.

Backend Milestone #7: [2pt] Authorization and user roles

• Add authorization with the cancancan gem
• Create user roles: Admin and User
• Implementation:
  • only the admin can add and delete an item

Frontend Milestone #8: [2pts] Write Unit and Integration Tests for Components

• Add unit tests for pure functions and components.
• Add Integration Tests.

Backend Milestone #4: [2pt] Create Migration tables, add associations, validations, console testing

• create models, add associations, and validations, and do manual testing.
• seed the database for testing

Frontend Milestone #1: [2pts] Create Login and Signup Page

• The user enters the website by entering their Email and Password!
• The user signup by entering their name, email, password, and confirmation password!

Backend Milestone #5: [8pt] Provide API for the front end.

• Create API so that the data can be accessed from the front end using active_model_serializer.

Frontend Milestone #3: [4pt] Use redux to manage the state of the application.

• Create Store, Actions, and Reducers for Redux.
• Implement every API call both GET and POST in the Redux.
• On the main page, the user can see a list of activities.

Frontend Milestone #7: [2pts] Make App Responsive

• Make the app responsive, creating both mobile, tablet, and desktop versions.

Backend Milestone #6: [3pts] Generate the Api documentation

• Generate the API documentation with rswag

Frontend Milestone #4: [2pts] Details Page.

• When the user selects a specific item, they can see the details page with its full description (skip the "Rotate image" button).

• On the details page, the user can click the "Reserve" button (in the design you can see the "Configure" button - please replace it with the "Reserve" button).