From 9762d30d8d4c7d237601131e2c5b2624e9b41889 Mon Sep 17 00:00:00 2001
From: Debapriyo Das <debapriyo00@gmail.com>
Date: Sat, 4 Jul 2026 12:18:14 +0530
Subject: [PATCH] update Readme file

Co-Authored-By: Is/Debu <145922247+isdebu999@users.noreply.github.com>
---
 README.md | 232 +++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 188 insertions(+), 44 deletions(-)

diff --git a/README.md b/README.md
index c4357ff..2265c96 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,12 @@
-# Medical Prescription Portal
+<div align="center">
 
-A full-stack web application built for the secure and seamless exchange of medical prescriptions between doctors and patients. This system ensures that patients never lose access to their prescriptions, providing secure on-demand retrieval using OTP verification.
+# 💊 Medical Prescription Portal
 
-<p align="left">
+**A secure, full-stack platform for digital prescription exchange between doctors and patients.**
+
+Say goodbye to lost paper prescriptions — doctors upload, patients retrieve, OTP verifies. Simple, secure, always accessible.
+
+<p align="center">
   <a href="https://react.dev/"><img src="https://img.shields.io/badge/Frontend-React-61DAFB?style=flat-square&logo=react&logoColor=black" alt="React" /></a>
   <a href="https://tailwindcss.com/"><img src="https://img.shields.io/badge/Styling-TailwindCSS-38B2AC?style=flat-square&logo=tailwindcss&logoColor=white" alt="TailwindCSS" /></a>
   <a href="https://spring.io/projects/spring-boot"><img src="https://img.shields.io/badge/Backend-SpringBoot-6DB33F?style=flat-square&logo=springboot&logoColor=white" alt="SpringBoot" /></a>
@@ -12,74 +16,214 @@ A full-stack web application built for the secure and seamless exchange of medic
   <img src="https://img.shields.io/badge/Status-Active-success?style=flat-square" alt="Status" />
 </p>
 
+</div>
+
 ---
 
-## Table of Contents
-- [Project Overview](#project-overview)
-- [User Roles](#user-roles)
-  - [Doctor](#doctor)
-  - [Patient](#patient)
-- [Features in Detail](#features-in-detail)
-- [Contact](#contact)
-- [Summary](#summary)
+## 📑 Table of Contents
+
+- [Overview](#-overview)
+- [Tech Stack](#-tech-stack)
+- [System Architecture](#-system-architecture)
+- [User Roles](#-user-roles)
+- [Features](#-features)
+- [Prescription Retrieval Flow](#-prescription-retrieval-flow)
+- [Getting Started](#-getting-started)
+- [Environment Variables](#-environment-variables)
+- [Security Considerations](#-security-considerations)
+- [Roadmap](#-roadmap)
+- [Contributing](#-contributing)
+- [Contact](#-contact)
+- [License](#-license)
 
 ---
 
-## Project Overview
-The Medical Prescription Portal is designed to digitize and simplify the prescription-sharing process.
+## 🧭 Overview
 
-Patients often lose or misplace physical prescriptions. This application solves that problem by enabling doctors to upload prescriptions online, allowing patients to securely download them at any time using OTP verification.
+The **Medical Prescription Portal** digitizes and simplifies the prescription-sharing workflow between healthcare providers and patients.
 
-### Key System Highlights
-*   **Doctor Dashboard:** Facilitates quick and easy prescription uploads.
-*   **Patient Portal:** A secure, login-free gateway for downloading prescriptions.
-*   **OTP Authentication:** Verifies patient identity before allowing file retrieval.
-*   **Secure Storage:** Safe and reliable storage of prescription files.
+Patients frequently lose or misplace physical prescriptions, creating friction when refilling medication or consulting another provider. This platform solves that problem by letting **doctors upload prescriptions digitally** and giving **patients secure, login-free access** to retrieve them on demand — authenticated via **email-based OTP verification**.
+
+### Highlights
+
+| Highlight | Description |
+| :--- | :--- |
+| 🩺 **Doctor Dashboard** | Fast, structured prescription uploads linked to patient records |
+| 🔐 **OTP Authentication** | Passwordless, time-bound identity verification for patients |
+| 📥 **Patient Portal** | Simple, login-free gateway to retrieve prescriptions anytime |
+| 🗄️ **Secure Storage** | Reliable, access-controlled storage of prescription files |
 
 ---
 
-## User Roles
+## 🛠️ Tech Stack
 
-### Doctor
-Doctors use this system to:
-- Upload patient prescriptions.
-- Enter the patient's registered email address.
-- Store files securely.
-- Enable patients to retrieve prescriptions at any time.
+| Layer | Technology |
+| :--- | :--- |
+| Frontend | React, Tailwind CSS |
+| Backend | Spring Boot (Java) |
+| Database | MySQL |
+| Auth | Email-based OTP |
+| File Storage | Local / cloud object storage (configurable) |
 
 ---
 
-### Patient
+## 🏗️ System Architecture
+
+```
+┌───────────────┐        ┌──────────────────┐        ┌───────────────┐
+│   Doctor UI   │───────▶│  Spring Boot API │───────▶│  MySQL DB     │
+│ (React/Tailwind)│      │  (REST Services) │        │ (Patients,    │
+└───────────────┘        │                  │        │  Prescriptions)│
+                          │                  │        └───────────────┘
+┌───────────────┐        │                  │        ┌───────────────┐
+│  Patient UI   │───────▶│  OTP Service ─────────────▶│  Email Provider│
+│ (React/Tailwind)│      │  (Generate/Verify)│        │  (SMTP)        │
+└───────────────┘        └──────────────────┘        └───────────────┘
+                                   │
+                                   ▼
+                          ┌──────────────────┐
+                          │  File Storage     │
+                          │ (Prescriptions)   │
+                          └──────────────────┘
+```
+
+---
+
+## 👥 User Roles
+
+### 🩺 Doctor
+
+Doctors use the platform to:
+- Upload prescription files (PDF/Image) for a patient.
+- Associate uploads with the patient's registered email address.
+- Maintain a history of issued prescriptions per patient.
+- Ensure patients retain long-term access without needing physical copies.
+
+### 🧑‍⚕️ Patient
+
 Patients can:
-- Enter their registered email address.
-- Receive a secure One-Time Password (OTP) via email.
-- Verify their identity by entering the correct OTP.
-- Download their prescription instantly.
+- Enter their registered email address to initiate a request.
+- Receive a secure, time-limited One-Time Password (OTP) via email.
+- Verify their identity by submitting the correct OTP.
+- Instantly download their prescription upon successful verification.
 
 ---
 
-## Features in Detail
+## ✨ Features
 
 | Component | Feature | Description |
 | :--- | :--- | :--- |
-| **Doctor Features** | Upload Prescription | Upload PDF/Image prescription files. |
-| | Patient Records | Manage patient association records. |
-| | Secure Storage | Encrypted or protected repository path. |
-| **Patient Features** | Request OTP | Request temporary token to email. |
-| | Verify OTP | Authenticate the token securely. |
-| | Download Prescription | Retrieve and download file instantly. |
+| **Doctor Features** | Upload Prescription | Upload PDF/Image prescription files |
+| | Patient Records | Manage and associate patient records |
+| | Secure Storage | Encrypted / access-controlled file repository |
+| **Patient Features** | Request OTP | Request a temporary token via email |
+| | Verify OTP | Authenticate the token securely |
+| | Download Prescription | Retrieve and download the file instantly |
+
+---
+
+## 🔄 Prescription Retrieval Flow
+
+1. **Patient** enters their registered email on the portal.
+2. System generates a time-bound **OTP** and sends it to the email.
+3. **Patient** submits the OTP for verification.
+4. On success, the system authorizes a **one-time secure download link**.
+5. **Patient** downloads the prescription instantly.
 
 ---
 
-## Contact
+## 🚀 Getting Started
+
+### Prerequisites
+- Java 17+
+- Node.js 18+
+- MySQL 8+
+- Maven
+
+### Backend Setup
+```bash
+cd backend
+mvn clean install
+mvn spring-boot:run
+```
+
+### Frontend Setup
+```bash
+cd frontend
+npm install
+npm run dev
+```
+
+### Database Setup
+```sql
+CREATE DATABASE prescription_portal;
+```
+Update your database credentials in `application.properties` before starting the backend.
 
-Feel free to reach out for inquiries or feedback:
+---
+
+## 🔑 Environment Variables
 
-*   **Email:** [debapriyo00@gmail.com](mailto:debapriyo00@gmail.com)
-*   **GitHub:** [debapriyo007](https://github.com/debapriyo007)
+| Variable | Description |
+| :--- | :--- |
+| `DB_URL` | MySQL connection string |
+| `DB_USERNAME` | Database username |
+| `DB_PASSWORD` | Database password |
+| `MAIL_HOST` | SMTP host for sending OTP emails |
+| `MAIL_USERNAME` | SMTP account username |
+| `MAIL_PASSWORD` | SMTP account password |
+| `OTP_EXPIRY_MINUTES` | OTP validity duration |
 
 ---
 
-## Summary
+## 🔒 Security Considerations
+
+- OTPs are time-bound and single-use to prevent replay attacks.
+- Prescription files are stored in an access-controlled repository, never publicly indexed.
+- Email is used as the sole identifier to minimize the attack surface — no passwords are stored for patients.
+- All sensitive endpoints should be served over HTTPS in production.
+
+---
+
+## 🗺️ Roadmap
+
+- [ ] Two-factor authentication for doctors
+- [ ] Patient prescription history dashboard
+- [ ] Mobile-responsive UI enhancements
+- [ ] Audit logs for prescription access
+- [ ] Multi-language support
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! To contribute:
+
+1. Fork the repository.
+2. Create a feature branch (`git checkout -b feature/your-feature`).
+3. Commit your changes (`git commit -m "Add your feature"`).
+4. Push to the branch (`git push origin feature/your-feature`).
+5. Open a Pull Request.
+
+---
+
+## 📬 Contact
+
+Feel free to reach out for inquiries, feedback, or collaboration:
+
+- **Email:** [debapriyo00@gmail.com](mailto:debapriyo00@gmail.com)
+- **GitHub:** [@debapriyo007](https://github.com/debapriyo007)
+
+---
+
+## 📄 License
+
+This project is licensed under the **MIT License**.
+
+---
+
+<div align="center">
+
+Built with the goal of making prescription management **simple, secure, and always accessible**.
 
-This project was built with the goal of creating a simple, secure, and reliable medical prescription portal. Future updates will focus on additional UI enhancements and security features.
+</div>
\ No newline at end of file