Bookings-Backend

Project Description

This project is an api built with Ruby on Rails as the second half of the final capstone project in the Microverse program.

It is built to serve as the back-end of the capstone project by storing, managing and serving data to the front-end project, which project can be found at this Github repository

The project implements a REST API to manage database resources which include User, Massage Types, and Appointments data.

🔧 Built With

• Ruby 3.0.1
• Ruby on Rails 6.1.3.2
• Postgresql 12.7

Tested with

• Rspec

🔴 API Link

• Norp Massage Parlor API

Get started on your local machine

Prerequisites

1. Ruby (This project was tested on version 3.0.1)
2. Rails (This project was tested on version 6.1.3.2)
3. Bundler (This project was tested with Bundler version 2.2.15)
4. Postgresql (This project was built with version 12.7)

Steps to follow

1. Clone the repository to your local machine using git clone it@github.com:RNtaate/Bookings-Backend.git
2. On your local machine, navigate to the Literature-Tracker folder using cd Bookings-Backend in your terminal
3. Install all the gems for the project by running bundle in your terminal
4. Create database using the following command rails db:create
5. Migrate the database using the following command rails db:migrate
6. Start the server by using the following command. rails s
7. Start running the front-end application to send and receive data from the api on your local server.

Testing the project

1. Run bundle exec rspec

🤝 Contributions

There are two ways of contributing to this project:

1. If you see something wrong or not working, please check the issue tracker section, if that problem you met is not in already opened issues then open the issue by clicking on new issue button.

2. If you have a solution to that, and you are willing to work on it, follow the below steps to contribute:

   1. Fork this repository
   2. Clone it on your local computer by running git clone git@github.com:RNtaate/Bookings-Backend.git Replace RNtaate with the username you use on github
   3. Open the cloned repository which appears as a folder on your local computer with your favorite code editor
   4. Create a separate branch off the master branch,
   5. Write your codes which fix the issue you found
   6. Commit and push the branch you created
   7. Raise a pull request, comparing your new created branch with our default branch here

✒️ Authors

👤 Roy Ntaate

• Github: @RNtaate
• Twitter: @RNtaate
• Linkedin: roy-ntaate

Show your support

Give a ⭐️ if you like this project!

Acknowledgements

• Microverse