harsh10tech/doctor-appointment

Introduction

A django project for doctors listing and to book appointments for patients. The system is for two kinds for user. For doctors and patients. Doctors can register, login and set there schedule accordigly. Patients can register, login, see all the available doctors based on location, specialization, and day of the week, and book an appointment also.

There are 7 endpoints:

• 3 for Doctors side
• 4 for Patient side

Watch the video demo here

Features

• Only Authenticated users can set doctors' schedules, get the list of doctors, and book an appointment.
• Token Authentication is used for the Authorization.

Installation Guide

• Clone the repo from here.
• Python is a must for the project, so install Python if not already there.

Usage

• Run the project with python manage.py runserver 8000
• Connect to the API endpoints using Postman or thunder client (VScode) on port 8000.

API Endpoints

The base url for all API endpoints is: locahost:8000/ and http://harshcode2020.pythonanywhere.com

Sl No.	HTTP Verbs	Endpoints	Action
1.	POST	/doctorapi/doctor/signup/	To sign up a new user account as a doctor
2.	POST	/doctorapi/doctor/signin/	To login an existing user account as a doctor. Returns a token.
3.	POST	/doctorapi/setdoc/setschedule/	To create a new schedule or edit the existing one
4.	POST	/patientapi/patient/signup/	To sign up a new user account as patient.
5.	POST	/patientapi/patient/signin/	To login an existing user account as a patient. Returns a token.
6.	POST	/patientapi/appointment/bookappointment/	To book an appointment.
7.	GET	/patientapi/appointment/getdoctors/	To retrive all the doctors and their data for the current month.

Technologies Used

• Django, Django-rest_framework
• VS Code as a platfrom

How to hit each endpoints

1. doctor/signup

   {
       'first_name':
       'last_name':
       'licence_number':
       'email':
       'phonenumber':
       'specialization':
       'description':
       'password':
   }
   

2. doctor/signin

   {
       'licence_number':
       'password':
   }
   

   Response

   {
       "success": "login successfull !!",
       "token": "72674f58xxxxxxxxxxxxx25a30e47"
   }
   

3. setdoc/setschedule

   {
       'loacation':
       'day':
       'start':
       'end':
       'duration':
       'date':
       'month':
       'appointments':
   }
   

4. patient/signup

   {
       'first_name':
       'last_name':
       'email':
       'phonenumber':
       'age':
       'password':
   }
   

5. patient/signin

   {
       'phonenumber':
       'password':
   }
   

   Response

   {
       "success": "login successfull !!",
       "token": "72674f58f51a6a3d67bc3xxxxxxxxx5a30e47"
   }
   

6. appointment/bookappointment

   {
       'date':
       'licence_number':
   }
   

7. appointment/getdoctors Response

   {
       "doctor": {
           "licence_number": "13w3e",
           "name": "Ankita Kumari",
           "specialization": "ortho",
           "description": "MD Gold Medal"
       },
       "schedule": {
           "location": "Cuttack",
           "day": "Friday",
           "start": "16:00:00",
           "end": "18:00:00"
       },
       "appointments": {
           "06-11-2023": 20
       }
   }