Skip to content

Aman-Codes/MedBuddy

Repository files navigation

MEDBUDDY

code style: prettier MIT

MedBuddy is a website that connects doctors, patients, and ambulance providers. Patients can select a date and doctor to consult, and the system will automatically generate an appointment time based on the doctor's schedule. Patients can also view their current and past appointments and book ambulance services. Doctors can accept or reject appointments, view all their current and past appointments, and upload detailed prescriptions for patients.

Visit Online

This website is hosted at https://medbuddy.onrender.com/

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Your machine should have Npm(or Yarn), Node.js, and MongoDB installed to use it locally.

Setup and Installation

Setting up the repository locally

  1. First fork the repo 🍴 to your account.
    Go to the forked repo and clone it 👥 to your local machine:
git clone https://github.com/Your_Username/MedBuddy.git

This will make a copy of the code to your local machine.

  1. Now move to the MedBuddy directory.
cd MedBuddy
  1. Now check the remote of your local code by:
git remote -v

The response should look like:

origin	https://github.com/Your_Username/MedBuddy.git (fetch)
origin	https://github.com/Your_Username/MedBuddy.git (push)

To add upstream to remote, run:

git remote add upstream https://github.com/Aman-Codes/MedBuddy.git

Again run git remote -v, the response should look like:

origin	https://github.com/Your_Username/MedBuddy.git (fetch)
origin	https://github.com/Your_Username/MedBuddy.git (push)
upstream	https://github.com/Aman-Codes/MedBuddy (fetch)
upstream	https://github.com/Aman-Codes/MedBuddy (push)
  1. Once the remote is set, install all the necessary dependencies by the following command:
npm install

Run locally

Run the below command to start the server:

npm run dev

Go to: http://localhost:4000

Contributing

We really like contributions in several forms, see CONTRIBUTING.md and CODE_OF_CONDUCT.md

User Documentation

For complete user documentation refer UserDocumentation.md