peterboro/Doctor-appointment-app-backend

Doctor's Appointment is a web application that allows users to book appointments with doctors. The application is built with React and Redux. The application is connected to a backend API that was built with Ruby on Rails.

Microverse README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • API Documentation
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Doctor's Appointment

Introducing our Rails-based backend app for streamlining doctor's appointments! With our user-friendly interface, patients can easily schedule appointments with their preferred doctor. The app can be accessed by using the front-end React app that we provide or by communicating with the backend via API requests

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• Rails

Database

• PostgreSQL

Key Features

• See all the doctor with thier details like name, picture, bio ..etc.
• Make appointment with preffered doctor
• Add new doctor if the user is admin

(back to top)

API Documentation

you can find the API Documentation here

🚀 Live Demo

• Live Demo Link For Back-end(Rails)
• Live Demo Link For Front-end(React)

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

• Have ruby installed on your PC
• Have node.js installed on your PC
• Have VS code editor

Setup

Clone this repository to your desired folder:

cd desired-folder-path
git clone https://github.com/yasinabdmahmood/Doctor-appointment-app-backend.git
cd Doctor-appointment-app-backend

Setup for front-end

Clone this repository to your desired folder:

cd desired-folder-path
git clone https://github.com/yasinabdmahmood/Doctor-appointment-react.git
cd Doctor-appointment-react

Install

Install this project with: bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using render or heroku platform

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 yaseen

• GitHub: @yasinabdmahmood
• LinkedIn: yaseen Abd alwahid

👤 Toma John Musa

• GitHub: @Kamba56
• Twitter: @Kamba_TJ

👤 Benard Pacho

• GitHub: @benardop
• Twitter: @Bepacho
• LinkedIn: Ochieng Benard

👤 Peter Njuguna

• GitHub: @peterboro
• Twitter: @Ptahbn

(back to top)

🔭 Future Features

• Add the ability to reschedule the appointmet
• The ability to commuicate with the doctors via message
• The ability to commuicate with the doctors via video call

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a star

(back to top)

🙏 Acknowledgments

I would like to thank Murat Korkmaz for the desin that the front-end app of the project was inspired by

(back to top)

❓ FAQ (OPTIONAL)

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)