https://github.com/katarighe/book-appointment-back-end
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.
https://github.com/katarighe/book-appointment-back-end
api microverse-projects microverse-rails-capstone rails ruby
Last synced: about 2 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/katarighe/book-appointment-back-end
- Owner: katarighe
- License: mit
- Created: 2023-11-29T17:08:41.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-12-15T12:02:03.000Z (over 2 years ago)
- Last Synced: 2025-06-19T10:52:22.588Z (about 1 year ago)
- Topics: api, microverse-projects, microverse-rails-capstone, rails, ruby
- Language: HTML
- Homepage: https://book-doctor-appointment-frontend.netlify.app/
- Size: 1.26 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Book A Doctor Appointment (Backend)
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Frontend Version](#frontend-version)
- [Kanban Board](#kanban-board)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#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.
Client
Server
Database
Tests / API
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**
- [Frontend version](https://github.com/katarighe/book-appointment-front-end)
- [Original Kanban Board](https://github.com/users/katarighe/projects/4/views/1)
- [Live Demo Link](https://book-doctor-appointment-frontend.netlify.app/)
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.
👤 **Mohamed Aden Ighe**
- GitHub: [@katarighe](https://github.com/katarighe)
- Twitter: [@katarighe](https://twitter.com/katarighe)
- LinkedIn: [@mighe](https://linkedin.com/in/mighe)
👤: **Antoine Makdessy**
- GitHub: [@ANTOINE1128](https://github.com/ANTOINE1128)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/antoine-makdessy/)
👤 **Andry Narson**
- GitHub: [@rbd3](https://github.com/rbd3)
- LinkedIn: [@Andry Narson Rabedesana](https://linkedin.com/in/andry-rabedesana)
👤 **Sodeeq Awoyemi**
- GitHub: [@githubhandle](https://github.com/Errytagedesign)
- Twitter: [@twitterhandle](https://twitter.com/errytage)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/errytagedesigns/)
👤 **Clarence Atim**
- GitHub: [@ClarenceAtim](https://github.com/ClarenceAtim)
- LinkedIn: [@Clarence Atim](https://www.linkedin.com/in/tegum-clarence-atim/)
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.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a star⭐️ or a thumbs up 👍 if you like this project! You can visit my GitHub profile for more of my projects.
- Project supervised by [Microverse](https://www.microverse.org/)
- [Creative Commons 4.0 License](https://creativecommons.org/licenses/by-nc/4.0/)
- Original design theme is by [Murat Korkmaz on Behance](https://www.behance.net/muratk)
- [Link to the original design theme](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign/modules/173005579) by Murat Korkmaz
This project is [MIT](./LICENSE) licensed.