BOOK_APPOINTMENT-BACK-END

This is backend API for the BOOK_APPOINTMENT-Front-End UI, built with Ruby-on-Rails and Postgresql. This API manages reservations for car test runs across various locations.

Built with

Ruby version 3.1.2
Rails (RoR) version 7.0.4
Postgresql
Rubocop

Live Link

You can access the Live version and use the API via this link.

Front-End

You can access the front-end of this application via this link.

Kanban Board:

Kanban Board link Initial state of the Kanban Board:

SetUp

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

You should have Ruby installed on your computer.
You should also have Rails installed on your computer.
Clone this repository into your computer by running the following command in your terminal:

> git clone git@github.com:jahongiry/book-appointment_back-end.git
> cd book-appointment-backend

Run this command in the cloned directory, to install required gems:

> bundle install

Then create the posgreSQL database needed for this app, run the migrations and seed data with the following commands:

> rails db:create
> rails db:migrate
> rails db:seed

Run Rubocop -A and fix linters errors, if any.

Run the project in your browser:

rails server

Run Tests

To run tests, Run the following command on your terminal

rake rswag

Deployment

Live link fron-end

Live link back-end

The above endpoint permits you to see all cars available for reservation. Checkout the api documentation below for the other endpoints.

API Documentation

Visit this endpoint to see a complete documentation of all available endpoints for this API. We hope this helps you find your way around our API.

Authors

👤 Assad Isah

GitHub: @nottherealalanturing
LinkedIn: Assad Isah

👤 Emirjeta Veisllari

GitHub: @myelin0
Twitter: @Amy_Albania
LinkedIn: @Emirjeta Veisllari

👤 Jahongir Yusupov

GitHub: @Jahongir
LinkedIn: jahongir-yusupov
Twitter: JahongirYusup13

👤 Zelalem Fissha

GitHub: @Zelalem1222
LinkedIn: zelalemfissha
Twitter: Zelalem52236790

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

Coding Partners
Hat tip to Microverse
We acknowledge Murat Korkmaz on Behance for designing the wireframe used in this project.

📝 License

This project is MIT licensed.

nottherealalanturing / book-appointment_back-end