https://github.com/abigiyaty/carrental-backend

Backend REST API for a car rental application. It is written in Ruby on Rails and uses JWT for authentication. The API provides endpoints for creating, updating, and deleting cars, as well as for reserving and returning cars. It also provides an endpoint for getting the current status of a car.
https://github.com/abigiyaty/carrental-backend

postgresql rspec ruby-on-rails

Last synced: about 1 month ago
JSON representation

Backend REST API for a car rental application. It is written in Ruby on Rails and uses JWT for authentication. The API provides endpoints for creating, updating, and deleting cars, as well as for reserving and returning cars. It also provides an endpoint for getting the current status of a car.

• Host: GitHub
• URL: https://github.com/abigiyaty/carrental-backend
• Owner: AbigiyaTY
• Created: 2023-04-11T19:58:00.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2024-01-26T11:59:15.000Z (about 1 year ago)
• Last Synced: 2024-12-20T10:28:41.405Z (about 2 months ago)
• Topics: postgresql, rspec, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 633 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [ Car-Rental ](#-car-rental-)

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

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

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

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Author ](#author-)

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

  - [🤝 Contributing ](#-contributing-)

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

  - [📝 License ](#-license-)

# 📖 Car-Rental 

- **Car Rental** is a  car rental application that used React for Front-End and Ruby on Rails for Back-End.

- **Car Rental Backend** is Backend REST API for a car rental application. It is written in Ruby on Rails and uses JWT for authentication. The API provides endpoints for creating, updating, and deleting cars, as well as for reserving and returning cars. It also provides an endpoint for getting the current status of a car. 

## 🛠 Built With 

### Tech Stack 

  Back-End

  


    
Ruby on Rails

  


  Database

  


    
PostgreSQL

  


Test

  


    
RSPEC

  


### Key Features 

- **Create, update, and delete cars**

- **Reserve and return cars**

- **Get the current status of a car**

- **Authentication with JWT**

  

(back to top)


## 💻 Getting Started 

**To get a local copy running the follow these steps.**

### Prerequisites

In order to run this project you need 

```sh

 VS code editor

 Web browser(chrome Firefox Opera etc)

 gem install rails

```

### Setup

Clone this repository to your desired folder:

```sh

  git clone https://github.com/AbigiyaTY/carRental-Backend.git

```

### Install

In the terminal, go to your file directory and run this command.

```sh

  1. git clone https://github.com/AbigiyaTY/carRental-Backend.git

  2. cd carRental-Backend

  3. code .

```

gem install bundler

  ```sh

    1. bundler install

    2. rails db:create db:migrate

  ```

### Usage

To run the project, execute the following command:

```sh

  rails server

```

## Run tests

To install rspec, in the terminal kindly run this command

```

$ gem install rspec

```

To run tests, please run this command

```

For specific file

$ rspec ./spec/#{filename}.rb 

For the whole file

$ rspec 

```

(back to top)


## Author 

 

 **Abigiya Tadesse**

* GitHub: [@AbigiyaTY](https://github.com/AbigiyaTY)

* Twitter: [@AbigiyaTY](https://twitter.com/AbigiyaTY)

* LinkedIn: [@AbigiyaTY](https://www.linkedin.com/in/AbigiyaTY)

(back to top)


## 🔭 Future Features 

- [ ] **Improve security**

- [ ] **Delploy the app**

- [ ] **Add testes**

- [ ] **Write documentation** 

(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 give it ⭐️.

(back to top)


## 📝 License 

This project is [MIT](./MIT.md) licensed.

(back to top)