📗 Table of Contents

• 📗 Table of Contents
• 📖 vehicle booking app
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Frontend Repository
    • ERD Image
    • API Documentation
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 vehicle booking app

vehicle booking app is a Booking app made connectively with Ruby in Rails and React for front-end vehicle booking app React frontend App in JSON format through an API endpoint.

🛠 Built With

Tech Stack

Client

• React
• React-Redux
• Redux Toolkit

-

Server

• Ruby on Rails
• PostgreSQL

Key Features

• Rails API backend
• React Front-end
• Redux Toolkit used to consume the backend api

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

• A text editor of your choice (VS Code works well).
• Ruby and Rails
• Git

Setup

Use the following URL to clone this project:

git clone https://github.com/tan12082001/Vehicle-Booking-App-Backend.git

Install

Open the terminal in the root directory of the project and run the following command to install all dependencies.

- bundle install
- secret_base_key generation
  In terminal: 
  * rm credentials.yml.enc
  * $ EDITOR="mate --wait" bin/rails credentials:edit

- configure database
  In terminal: 
  * run `rails db:create`
  * run `db:migrate`

- Rspec
  In terminal: 
  * bundle exec rails db:schema:load RAILS_ENV=test

Frontend Repository

Reference the Frontend Repository for the corresponding frontend.

ERD Image

ERD image to visualize the database schema

API Documentation

For details on how to interact with the API, view the API documentation. Follow the steps below:

- run server `rails s`
- open in browser `http://localhost:4000/api-docs`

Usage

To start the development server, run the following command then navigate to localhost:4000 in your browser.

rails s

Open http://localhost:4000 to view it in your browser.

Run tests

To run tests, use the following command:

  rspec

(back to top)

👥 Authors

👤 Suleiman Gacheru

• GitHub: @hetrox8
• Twitter: @suleimangacheru

👤 Tanmayi manku

• GitHub: @tan12082001

👤 Nweneary Uzochukwu Winnie

• GitHub: @wineshuga
• LinkedIn: LinkedIn

👤 Bolaji Toyib

• GitHub: @toyybi bolaji

(back to top)

🔭 Future Features

• None planned

(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, please give it a star ⭐️ and share it with your friends.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing the resources and guidelines that enabled me to complete this project.

(back to top)

📝 License

This project is MIT licensed.