Skip to content

Commit fd818f6

Browse files
committed
Update README.md
1 parent 0246c69 commit fd818f6

File tree

1 file changed

+131
-2
lines changed

1 file changed

+131
-2
lines changed

README.md

Lines changed: 131 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,133 @@
1+
# Healvista Hospital Management System
2+
3+
A modern, full-stack hospital management system for seamless hospital operations, built with React, Tailwind CSS, Zustand, Lucide React, Node.js, Express, and MS SQL Server.
4+
5+
---
6+
7+
## 🚀 Project Overview
8+
9+
Healvista is a role-based hospital management platform designed to streamline hospital workflows for administrators, doctors, and patients. It provides real-time dashboards, management tools, and a beautiful, responsive UI for all user types.
10+
11+
---
12+
13+
## 🛠️ Tech Stack
14+
15+
- **Frontend:** React, Tailwind CSS, Zustand, Lucide React, React Router
16+
- **Backend:** Node.js, Express, mssql (MS SQL Server)
17+
- **Database:** MS SQL Server
18+
19+
---
20+
21+
## ✨ Features
22+
23+
### Authentication & Role-Based Access
24+
- Secure login for Admin, Doctor, and Patient roles
25+
- Role-based dashboards and navigation
26+
27+
### Admin Dashboard
28+
- Overview widgets: doctors, patients, appointments, billing, pharmacy, labs, etc.
29+
- Management pages for:
30+
- Users
31+
- Doctors
32+
- Patients
33+
- Appointments
34+
- Pharmacy (medicines)
35+
- Labs (lab tests)
36+
- Billing
37+
- Ambulances
38+
- Feedback
39+
- CRUD operations for all entities
40+
41+
### Doctor Dashboard
42+
- Overview: today's appointments, total patients, pending labs, critical patients
43+
- Appointments management
44+
- Patient list and details
45+
- Lab test management
46+
- Pharmacy (prescribe/view medicines)
47+
- Responsive, real-time data
48+
49+
### Patient Dashboard
50+
- Overview: upcoming appointments, lab results, billing, etc.
51+
- Book/view appointments
52+
- View available doctors
53+
- View all available medicines
54+
- View lab reports
55+
- Request ambulance
56+
- Submit/view feedback
57+
58+
---
59+
60+
## 📦 Project Structure
61+
62+
```
63+
Healvista--hospital-management-system/
64+
├── back_end/ # Node.js/Express backend
65+
│ ├── config/ # Database config
66+
│ ├── controller/ # Route controllers
67+
│ ├── routes/ # API routes
68+
│ └── server.js # Entry point
69+
├── front_end/ # React frontend
70+
│ ├── src/
71+
│ │ ├── components/ # UI and layout components
72+
│ │ ├── pages/ # Page components (dashboards, management)
73+
│ │ ├── store/ # Zustand stores
74+
│ │ └── App.jsx # Main app
75+
│ └── ...
76+
├── README.md # This file
77+
└── ...
78+
```
79+
80+
---
81+
82+
## ⚡ Getting Started
83+
84+
### Prerequisites
85+
- Node.js (v16+ recommended)
86+
- npm
87+
- MS SQL Server (local or remote)
88+
89+
### 1. Clone the Repository
90+
```bash
91+
git clone <repo-url>
92+
cd Healvista--hospital-management-system
93+
```
94+
95+
### 2. Backend Setup
96+
```bash
97+
cd back_end
98+
npm install
99+
# Configure your .env file with DB credentials (see config/db.js)
100+
npm start
101+
```
102+
103+
### 3. Frontend Setup
104+
```bash
105+
cd ../front_end
106+
npm install
107+
npm run dev
108+
```
109+
110+
### 4. Access the App
111+
- Open [http://localhost:5173](http://localhost:5173) in your browser.
112+
- Login as Admin, Doctor, or Patient (see your Users table for credentials).
113+
114+
---
115+
116+
## 📝 Usage Notes
117+
- **Role-based routing:** Users are redirected to their dashboard after login.
118+
- **Admin:** Full access to all management features.
119+
- **Doctor:** Can view/manage their appointments, patients, labs, and more.
120+
- **Patient:** Can view appointments, doctors, medicines, labs, and request ambulance.
121+
- **Medicines:** All patients see all available medicines (no patient-specific filtering yet).
122+
- **API Proxy:** The frontend uses a Vite proxy to connect to the backend (`/api/*` routes).
123+
124+
---
125+
126+
## 📚 Customization & Extending
127+
- To add patient-specific medicines, implement a patient-medicine relationship in the backend and expose an endpoint like `/api/pharmacy/patient/:id`.
128+
- To add more granular permissions, implement route protection using a PrivateRoute/ProtectedRoute component.
129+
- Easily extend dashboards with more widgets, analytics, or management features.
130+
131+
1132

2-
# Healvista--hospital-management-system
3-
a hospital management system designed to optimize healthcare facility operations and improve patient care. It streamlines administrative processes, enhances data security, and supports efficient resource management
4133

0 commit comments

Comments
 (0)