An API backend for managing vehicle rental & reservations, built with Ruby on Rails.
-
Clone the repo:
git clone git@github.com:bhushan354/Reservation-App-Backend.git cd Reservation-App-Backend -
Build and start backend service:
docker compose build docker compose up docker compose exec backend bash # Then inside the container app bash run following commands: rails db:drop rails db:create rails db:migrate rails db:seed
-
Access API documentation:
-
Now Headover To Frontend-Repo and follow Docker setup to make sure your app is working fine with React as a frontend : https://github.com/bhushan354/Reservation-App-Frontend
In order to run this project you need:
- ✔ Ruby installed in your machine. you can download it from here
- ✔ IDE or a code editor installed in your machine.
- ✔ IRB.
- ✔ Get Postgresql up and running. you can download it from here.
- ✔ Git installed in your machine.
- ✔ Sign in or sign up to your Github account.
- ✔ A professional editer such as VS Code.
- ✔ An Updated web browser such as Google Chrome, you can download it from here.
-
Clone the repository:
git clone git@github.com:bhushan354/Reservation-App-Backend.git cd Reservation-App-Backend -
Update database configuration:
- Edit
config/database.ymlwith your local PostgreSQL credentials.
- Edit
-
Ensure Ruby version compatibility:
- Match the Ruby version in your system with the one in the
Gemfile.
- Match the Ruby version in your system with the one in the
-
Install dependencies and set up the database:
bundle install rails db:drop rails db:create rails db:migrate rails db:seed
-
Start the Rails server:
rails server
-
Access API documentation:
- Open your browser and go to:
http://127.0.0.1:3000/api-docs/index.html
- Open your browser and go to:
Bhushan Deshmukh: +91 8600118932 | deshmukhbhushan380@gmail.com | https://www.linkedin.com/in/bhushan-deshmukh-codes/