Skip to content

Latest commit

 

History

History
118 lines (93 loc) · 4.82 KB

README.md

File metadata and controls

118 lines (93 loc) · 4.82 KB
Raw

Clinic_Appointment_App_API

Built with Django REST Framework

Table of Contents

Features

Implemented

  1. Create User
  • Generate token (Login), Revoke token by User
  • Update, View User profile by User owner
  • Forgot, Reset User Password by User owner
  • Delete, View user by Admin

  1. View User Activity Logs List by Admin

  2. Export User Activity Logs as CSV/Excel by Admin

    • Create, List, Detail, Update and Delete of User Roles by Admin

  3. Create, List, Detail, Update and Delete Doctor Speciality by Admin

  4. Create and List Clinic by User.

    • Detail, Update and Delete Clinic by Clinic Owner

  5. Clinic Invite Doctor by Clinic Owner

  6. Doctor Accept Invite by Invited Doctor

    • Doctor Reject Clinic Invite by Invited Doctor

  7. Create, List and Detail Doctor

    • Update and Delete Doctor by Owner Doctor

  8. Create, Update and Delete Doctor's Timeslot and Schedule by Owner Doctor

    • List and Detail view of Doctor's Timeslot and Schedule by any user

  9. Create, Update and Delete Doctor's Education, Awards, Experience, Membership and Registration by Owner Doctor.

    • List and Detail view of Doctor's Education, Awards, Experience, Membership and Registration by any user

  10. Create, List and Detail Patient

    • Update and Delete Patient by Owner Patient

  11. Book, cancel and request reschedule Appointment with a doctor by Patient

    • Accept, cancel, request reschedule and follow-up appointment by Doctor

  12. Create, List, Detail, Update and Delete Patient's Medical Record by Doctor

    • View Medical Record by owner patient

  13. Create, List, Detail, Update and Delete Patient's Presicription by DOCTOR

    • View Presicription by owner patient

  14. Appointment Billing

  15. Generate Invoices

  16. Review Doctor by Patient

  17. Doctor Reply to review

  18. Users like reviews and reply

Todo

  • Document apis with Postman
  • JWT Authentication
  • Payment endpoints
  • Create and Send appointment Notifications (Calery)
  • Geo-locate clinic
  • Doctor - Patient chat app

Installation Guide

Dependacies Installation

  • Installing the application locally requires
    1. Python 3.7+ - download and install it.
    2. virtualenv - To create a virtual environment and activate it, run the following commands.
     python3 -m venv venv
 source venv/bin/activate
  • Install the project dependacies from requirements.txt by running the following command in shell:
pip install -r requirements.txt

Testing and Running Guide

  1. To activate the development server run:
python manage.py runserver

At this point, the development server should be accessible at http://127.0.0.1:8000/

  1. Testing - To run all the tests:
python manage.py test

API Documentation

Key Python Modules Used

  • Django(3.2.18): Django is a back-end server side web framework. Django is free, open source and written in Python. Django makes it easier to build web pages using Python.
  • Django Rest Framework: Django Rest Framework (DRF) is a package built on the top of Django to create web APIs. DRF allows us to represent their functionality Django application in the form of REST APIs.
  • django-user-agents: A django package that allows easy identification of visitor’s browser, OS and device information, including whether the visitor uses a mobile phone, tablet or a touch capable device.
  • django-cors-headers: A Django App that adds Cross-Origin Resource Sharing (CORS) headers to responses. This allows in-browser requests to your Django application from other origins.
  • pilkit: PILKit is a collection of utilities for working with PIL (the Python Imaging Library). One of its main features is a set of processors which expose a simple interface for performing manipulations on PIL images.
  • openpyxl: The Openpyxl library is used to write or read the data in the excel file and many other tasks.
  • flake8 - static analysis tool

Reference Resources