Book A Doctor Appointment (Backend)

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Frontend Version
    • Kanban Board
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Book A Doctor appointments (Backend)

The Book A Doctor appointments (Backend) is a Rails application specifically designed for managing doctor appointments. This application utilizes API endpoints that allow users to load, create, and delete doctor information and appointments. Users must either sign up for an account or sign in to access these API endpoints.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript

Server

• Ruby
• Rails
• React

Database

• PostgreSQL

Tests / API

• Rspec
• Rswag

Key Features

The main features of this app include:

• Load, create, and delete doctors
• Load, create and delete appointments / reservations
• Signup and Signin feature
• Admin and User roles

(back to top)

Frontend Version

• Frontend version

(back to top)

Kanban Board

• Original Kanban Board

(back to top)

🚀 Live Demo

• Live Demo Link

(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 to install the following items:

• Ruby
• Ruby on Rails
• PostgreSQL

Setup

Clone this repository to your desired folder:

git clone git@github.com:katarighe/book-appointment-back-end.git
cd book-appointment-back-end

Install

Install this project by using:

bundle install

Setup database with:

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

Usage

To run the project, execute the following command to start the server:

rails server -p 3001

Visit http://localhost:3001/ in your browser.

Run tests

To run tests, run the following commands:

Install npm with:

npm install

Install rspec with:

bundle install

and

rails generate rspec:install

run the test with:

rspec spec

Visit /coverage/index.html in your browser.

To open API documentation, please execute the following command:

rails rswag:specs:swaggerize

Visit http://localhost:3001/api-docs in your browser.

(back to top)

👥 Authors

👤 Mohamed Aden Ighe

• GitHub: @katarighe
• Twitter: @katarighe
• LinkedIn: @mighe

👤: Antoine Makdessy

• GitHub: @ANTOINE1128
• LinkedIn: LinkedIn

👤 Andry Narson

• GitHub: @rbd3
• LinkedIn: @Andry Narson Rabedesana

👤 Sodeeq Awoyemi

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Clarence Atim

• GitHub: @ClarenceAtim
• LinkedIn: @Clarence Atim

(back to top)

🔭 Future Features

Here are some future features that could be added to the Book a Doctor appointments app in the future.

• Medication management
• Personalized healthcare plans
• Symptom checker
• Multilingual support
• Electronic health records (EHR)
• Clinical decision support
• Performance analytics
• Appointment reminders
• Wait time estimates
• Social features
• Patient communication
• Medical record access

These are just a few potential future features for the "Book a Doctor" appointments app. The specific features that are implemented will depend on the needs and preferences of the users, as well as the available resources and technology.

It is also important to consider the ethical implications of adding new features, such as the potential for bias in AI-powered tools and the need to protect patient privacy and security.

Ultimately, the goal of any new feature should be to improve the user experience and make it easier for patients and doctors to access and manage healthcare.

(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 star⭐️ or a thumbs up 👍 if you like this project! You can visit my GitHub profile for more of my projects.

(back to top)

🙏 Acknowledgments

• Project supervised by Microverse
• Creative Commons 4.0 License
• Original design theme is by Murat Korkmaz on Behance
• Link to the original design theme by Murat Korkmaz

(back to top)

📝 License

This project is MIT licensed.

(back to top)