/medical-appointments-back-end

The final capstone project is based on an app to book an appointment...

Primary LanguageRubyMIT LicenseMIT

📗 Table of Contents

📖 Health Clinic API

Health Clinic API This repository contains the Rails back-end API for the "Doctor Appointments" capstone project. The API serves as the foundation for user authentication, doctor management, appointment reservations, and related functionalities. It utilizes PostgreSQL as the database and is designed to be a robust and secure backend system. The API exposes endpoints for user login, doctor listing, doctor details, reservation creation, and user reservation listing. Additionally, it implements features such as marking a doctor as removed and comprehensive documentation for seamless integration with the front-end.

🛠 Built With

Ruby on Rails, Visual Studia Code, WSL

Tech Stack

  • Ruby on Rails
  • PostgreSQL
  • WSL

Key Features

  • User Authentication
  • Doctor Management
  • Reservation System
  • API Documentation

🚀 Live Demo

Kanban Board

(back to top)

💻 Getting Started

Setup

In order to use this project.. Clone this repository to your desired folder by pasting this command in your command line interface:

  git clone https://github.com/tajemouti/medical-appointments-back-end.git

You can also clone the front-end project using the following command:

  git clone https://github.com/tajemouti/medical-appointments-front-end.git

Prerequisites

Ruby on Rails Git

Install

To install the project's dependencies, run:

  bundle install
  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server

Run tests

To test, run:

  rspec

Front-end Project

Front-end project link.

(back to top)

👥 Authors

🔭 Future Features

  • Enhanced Authentication
  • Advanced Doctor Management
  • Appointment Reminders
  • Analytics and Reporting

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Kindly give this project a star if you like it.

(back to top)

🙏 Acknowledgments

We would like to thank Microverse.

(back to top)

📝 License

This project is MIT license.

(back to top)