README.md

Car Rentals Backend

📗 Table of Contents

• 📗 Table of Contents
• 📖 Car Rentals Backend
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Setup database
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Car Rentals Backend

Car Rentals Backend is a Rails API that serves as database to the Car Rentals Frontend project.

🛠 Built With

Tech Stack

Server

• Ruby On Rails

Database

• PostgreSQL

Key Features

• Create database
• Authenticate user using devise gem
• Generate Authentication Token using jwt-gem

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

  ruby 3.2.1
  rails

Setup

Clone this repository to your desired folder:

Example commands:

  cd your-folder
  git clone https://github.com/demix007/car-rentals-backend.git

Install

Install this project with:

Example command:

  cd my-project
  bundle install

Setup database

Setup database with:

Example command:

  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

Example command:

  rails server

Run tests

To run tests, run the following command:

Example command:

  rspec

(back to top)

👥 Authors

👤 Ayodeji Abidemi

• GitHub:
• Twitter:
• LinkedIn:

👤 Mohamed Hassan Noor

• GitHub:
• Twitter:
• LinkedIn:

👤 Houda Mzari

• GitHub:
• LinkedIn:

👤 Kashif

• GitHub:
• Twitter:
• LinkedIn:

(back to top)

🔭 Future Features

• Add authorization
• Add advance tests to all functionality
• Enhance cyber security for the database

(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 ⭐️. Your support is greatly appreciated!

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for giving us this chance to learn how to build a Rails API and connect it to a React frontend.

(back to top)

📝 License

This project is MIT licensed.

(back to top)