📗 Table of Contents

• 📗 Table of Contents
• 📖 [Car Rental App]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
  • Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [Car Rental App]

The [Car Rental App] is a web-based application that allows users to rent cars for a specified period of time. The application provides an easy and convenient way to rent a car without the hassle of visiting a rental car company.

🛠 Built With

Tech Stack

• Ruby 3.1
• Ruby on Rails 7
• PostgreSQL 15

Key Features

• Register an account
• Create and delete cars
• Make reservation for your favorite car

(back to top)

🚀 Live Demo

• Will be available soon

(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:

• Ruby
• Ruby on Rails
• PostgreSQL
• any code editor

Setup

Clone this repository to your desired folder:

To setup the project follow the steps:

1. Clone this project using Git Bash:

   git clone git@github.com:myaserkhan/Rentals-Backend.git
   

2. Inside the project directory, install the project's dependencies

   bundle install
   

3. Create the app's database

   rails db:create
   

4. Setup the app's database

   rails db:setup
   

5. Populate the database

    rails db:seed
   

Run tests

To run tests, run the following command:

  rake rswag

Available Scripts

In the project directory, you can run:

• rails server
  

  Runs the app local server

• bundle exec rspec
  

  Launches the test runner.

Author

👤 Sajeel Zafar

• GitHub: @Sajeelzafar
• Twitter: @SajeelZafar6
• LinkedIn: Sajeel Zafar

👤 Yasir Khan

• GitHub: @myaserkhan
• Twitter: @khanyaser007
• LinkedIn: Yasir-Khan

(back to top)

🔭 Future Features

• [I'll be adding proper authentication to the project in near future]
• [In future, I would be adding an option to buy the car as well]
• [Coming up I would be working on offering discounts if a user is a frequent customer]

(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 give it a star!

(back to top)

🙏 Acknowledgments

• Microverse ❤️

• Credit goes to Murat Korkmaz on Behance whose original design was used.

📝 License

This project is MIT licensed.

(back to top)