https://github.com/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.
https://github.com/nickemma/car-rental-api

database jwt-authentication postgresql ruby ruby-on-rails swagger-ui tdd

Last synced: about 5 hours ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/nickemma/car-rental-api
• Owner: nickemma
• License: mit
• Created: 2022-11-23T21:08:19.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-03-29T06:41:03.000Z (over 1 year ago)
• Last Synced: 2024-04-17T22:07:31.941Z (7 months ago)
• Topics: database, jwt-authentication, postgresql, ruby, ruby-on-rails, swagger-ui, tdd
• Language: Ruby
• Homepage: https://rails-production-c0ec.up.railway.app/api-docs/index.html
• Size: 192 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#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](https://github.com/NickEmma/car-rental-app)

## 🛠 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](https://rails-production-c0ec.up.railway.app/api-docs/index.html)

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

```sh

 gem install rails

```

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

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

```

### Install

Install this project with:

```sh

  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:

```sh

  rspec spec/integration

```

### Deployment

You can deploy this project using:

```sh

  git push heroku main

```

(back to top)


## 👥 Authors 

👤 **Nicholas Emmanuel**

- GitHub: [@NickEmma](https://github.com/NickEmma)

- Twitter: [@techieEmma](https://twitter.com/techieEmma)

- LinkedIn: [@Nicholas Emmanuel](https://www.linkedin.com/in/techieemma/)

👤 **Abdelmejid Oumer Ali**

- GitHub: [@amejid](https://github.com/amejid)

- Twitter: [@amejidoumer](https://twitter.com/amejidoumer)

- LinkedIn: [Abdelmejid Oumer Ali](https://linkedin.com/in/amejid)

👤 **Said laasri**

- GitHub: [@Said-laasri](https://github.com/Said-laasri)

- Twitter: [@saidlaasr](https://twitter.com/saidlaasr)

- LinkedIn: [SAID LAASRI](https://www.linkedin.com/in/said-laasri-8a4367172/)

👤 **Abel Desalegn**

- GitHub: [@Abel-desu](https://github.com/Abel-desu)

- Twitter: [@Abeldesalegn](https://twitter.com/abeldesalegn97)

- LinkedIn: [Abel Desalegn](https://www.linkedin.com/in/abel-desalegn92)

👤 **Mohamed Ashour**

- GitHub: [@githubhandle](https://github.com/AACHOURMOHAMED)

- Twitter: [@twitterhandle](https://twitter.com/MohamedAachour3)

- LinkedIn: [LinkedIn](https://linkedin.com/in/mohamed-aachour-25405b215)

(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](../../issues/).

(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](./LICENSE) licensed.

(back to top)