Skip to content

Commit 35c3cdc

Browse files
committed
update: readme.md
1 parent 2eeacea commit 35c3cdc

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

README.md

+30-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,32 @@
1-
### run locally
1+
# Healthcare Resource Allocation System
22

3-
```bash
4-
docker-compose up -d --build
5-
```
3+
## Project Overview
64

7-
visit the http://localhost:8000/docs for OPEN API docs
5+
This project focuses on optimizing healthcare resource allocation using different strategies like cost, distance, and greedy approaches. It addresses the critical issue of resource shortages in healthcare, especially during emergencies.
6+
7+
## Features
8+
9+
- **Resource Allocation**: Allocates hospital resources (e.g., oxygen, beds) using a strategy-based approach (distance, cost, greedy).
10+
- **Real-Time Data**: Tracks hospital resources in real-time and optimizes resource distribution based on the selected strategy.
11+
- **Supplier Management**: Manages and tracks the volume allocated to each hospital and the associated costs.
12+
- **Predictive Analysis**: Utilizes geolocation data for distance-based allocations and cost calculations.
13+
- **Emergency Response**: Prioritizes resource allocation during emergencies using real-time data.
14+
- **Traffic Handling**: Each request is processed as a background job to efficiently manage high traffic and ensure smooth performance.
15+
16+
## Tech Stack
17+
18+
- **Backend**: FastAPI (Python), running background jobs for resource allocation.
19+
- **Frontend**: Next.js (React-based framework) for the admin dashboard and visualization.
20+
- **Database**: PostgreSQL for storing hospital and resource data.
21+
- **API Testing**: Postman for collabrating and testing APIs, Open API (Swagger UI).
22+
- **Reverse Proxy**: Caddy, managing HTTPS and serving the app.
23+
- **Distance Calculation**: Geopy library for calculating distances between hospitals.
24+
- **ORM**: SQLModel, simplifying database queries and operations.
25+
- **CI/CD**: GitHub Actions for continuous integration and deployment.
26+
- **Hosting**: AWS EC2 for cloud infrastructure.
27+
28+
## Allocation Strategy Options
29+
30+
- **Greedy**: Allocates resources based on the highest value (e.g., cost per distance) in descending order.
31+
- **Distance-Based**: Prioritizes hospitals closest to the resource.
32+
- **Cost-Based**: Focuses on the least expensive options for resource allocation.

0 commit comments

Comments
 (0)