Full-Stack-Capstone-Backend: Vehicle Reservation App

# 📗 Table of Contents

• 📗 Table of Contents
• 📖 Full-Stack-Capstone-Backend
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • Front-End-Link
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Full-Stack-Capstone-Backend

The Full-Stack-Capstone-Backend is an API application for managing car rental databases.

🛠 Built With

• ✅ Ruby
• ✅ Ruby on Rails
• ✅ Postgresql
• ✅ Linters

Kanban Board

Link to Kanban Board: https://github.com/users/bhushan354/projects/6
Link to kanban board issue : bhushan354/Reservation-App-Frontend#12

Tech Stack

Language

• Ruby-on-Rails

Key Features

• 🔰 Reserve a Vehicle for a Particular Date or Add a Vehicle for Reservations.

(back to top)

Front-End-Link

The front-end repo is available here

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

1. Download or clone this repostory.
2. Provide a modern web browser.

Prerequisites

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.

Setup

• Clone this repository to your desired folder:

• Run this command in your command line interface:

  cd [YOUR FOLDER]
  git clone git@github.com:bhushan354/Reservation-App-Backend.git
  cd Reservation-App-Backend

• open the folder in your code editor

• Update the config/database.yml with your database credentials under the development section

• Update the GEMFILE to match your version of ruby.

• Run these command in your command line interface:

 sudo bundle install
 rails db:drop
 rails db:create
 rails db:migrate
 rails db:seed

• (Note : this 'sudo bundle install' command is only for UNIX and LINUX users if you are using windows run the terminal as a administrator and then run 'bundle install')

Usage

• To run the project, execute the following command:

   rails server

Api-Documentation

• After running 'rails server' paste this link in your browser to see full Api-Documentation.

   http://127.0.0.1:3000/api-docs/index.html

Deployment

This project is deployed by the author, no permission for deployment by any other client.

(back to top)

👥 Authors

👤 Muhammad Umair Muqeem

• GitHub: @umair-rao
• Twitter: @umair_ra0
• LinkedIn: LinkedIn

👤 Eugene Omwomo

• GitHub: @Omwomo
• Twitter: @eugeneoduor9
• LinkedIn: LinkedIn

👤 Bhushan Deshmukh

• GitHub: @bhushan354
• LinkedIn: Bhushan Deshmukh

(back to top)

🔭 Future Features

• Add info about each category

(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, kindly drop a start ⭐ for the repository;

(back to top)

🙏 Acknowledgments

I would like to express my heartfelt gratitude to Microvere for the invaluable learning experience they have provided. Also I would like to thank to Stanley osagie for his support during react.

(back to top)

📝 License

This project is MIT licensed.

(back to top)