Car Rental Backend is a rails backend application for booking Cars. This application serves as API endpoints for the frontend users to load, create, and delete Cars, as well as make reservations. Users need to sign up and/or sign in to access the API endpoints. They can sign up or sign in using the API endpoints.
- Major languages (Ruby)
- Framworks (Ruby on Rails)
- Testing library (Rspec)
- API docs (Rswag)
To get a local copy up and running follow these simple example steps.
- A text editor(preferably Visual Studio Code)
- Ruby
- Ruby on Rails
- PostgresSQL
- Clone the project
git clone https://github.com/Arturgouveia1970/car-rental-backend.git
cd car-rental-backend
Add your username & password in database.yml
file:
username: <your_username>
password: <your_password>
Specify your ruby version if different from mine
ruby 'Your_ruby_version'
Install gems with:
bundle install
Setup database with:
rails db:create
rails db:migrate
rails db:seed
Start server with:
rails server -p 3000
Visit https://localhost:3000/ in your browser.
Install npm with:
npm install
Install rspec with:
bundle install
and
rails generate rspec:install
run the test with:
rspec spec
rails rswag:specs:swaggerize
Visit https://localhost:3000/api-docs in your browser.
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!
- We acknowledge with appreciation the original design provided by Murat Korkmaz on Behance.
- Inspiration: Microverse.
This project is MIT licensed.