/DocBooker-Backend

A Ruby on Rails Back-end created with resources for users, doctors, and reservations. Exposes API endpoints to a Front-end client application that enables users to schedule appointments with doctors. Stack: Ruby on Rails, PostgreSQL, Restful-api, RSwag

Primary LanguageRuby

📗 Table of Contents

📖 [DocBooker Backend]

A Ruby on Rails backend created with resources for users, doctors, and reservations. Exposes API endpoints to a Frontend client application that enables users to schedule appointments with doctors.

🛠 Built With

Tech Stack

Server
Database

Key Features

  • [create_user]
  • [create_doctors]
  • [create_appointment]

(back to top)

🚀 Live Demo

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

  • Ruby
  • Ruby on Rails
  • Node

Setup

You can find the React Frontend client at React_client

Clone this repository to your desired folder:

To run and view this application, you will first have to clone a local version of this repository using:

git clone https://github.com/j-tee/booking-app.git

After that navigate to the newly created folder:

cd booking-app

Install

Install this project with: bundle install

Usage

  • To run the project follow the instructions below:

  • You can find the React Frontend client at React_client

  • Configure PostgreSQL database in your project in the project directory:

config/database.yml

  • Then run the following command to setup the database:
rails db:create, rails db:migrate, rails db:seed
  • Start a local server running the command:

rails s

Run tests

To run tests, run the following command:

bundle exec rspec ./spec/requests
bundle exec rspec ./spec/controllers

(back to top)

👥 Authors

👤 Salim Abdulai

👤 Samuel

👤 Julius

(back to top)

🔭 Future Features

  • [authentication]
  • [authorizations]
  • [sessions]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

  • Microverse for providing an excellent curriculum that has helped me enhance my skills in software development.
  • Code Reviewers for their valuable feedback and guidance throughout my learning journey.

(back to top)

Kanban Board

(back to top)

📝 License

This project is MIT licensed.

(back to top)