Initial commit - BraceIQMed platform with frontend, API, and brace generator
This commit is contained in:
76
README.md
Normal file
76
README.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# BraceIQMed
|
||||
|
||||
Medical scoliosis brace generation platform.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
braceiqmed/
|
||||
├── frontend/ # React + Vite + Three.js
|
||||
├── api/ # Node.js Express API server
|
||||
├── brace-generator/ # FastAPI + PyTorch brace generation
|
||||
├── templates/ # Brace template STL/GLB files
|
||||
├── scoliovis-api/ # ScolioVis ML model for spine detection
|
||||
└── scripts/ # Deployment scripts
|
||||
```
|
||||
|
||||
## Quick Start (Local Development)
|
||||
|
||||
```bash
|
||||
# Build all containers
|
||||
docker compose build
|
||||
|
||||
# Start all services
|
||||
docker compose up -d
|
||||
|
||||
# View logs
|
||||
docker compose logs -f
|
||||
|
||||
# Stop all services
|
||||
docker compose down
|
||||
```
|
||||
|
||||
Access at: http://localhost
|
||||
|
||||
## Deployment (EC2)
|
||||
|
||||
### First-time setup on server:
|
||||
|
||||
```bash
|
||||
# Clone the repo
|
||||
git clone https://github.com/YOUR_USERNAME/braceiqmed.git ~/braceiqmed
|
||||
cd ~/braceiqmed
|
||||
|
||||
# Build and start
|
||||
docker compose build
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### Update deployment:
|
||||
|
||||
```bash
|
||||
cd ~/braceiqmed
|
||||
git pull
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
Or use the deploy script:
|
||||
```bash
|
||||
./scripts/deploy.sh
|
||||
```
|
||||
|
||||
## Services
|
||||
|
||||
| Service | Internal Port | Description |
|
||||
|---------|---------------|-------------|
|
||||
| Frontend | 80 | React SPA + nginx proxy |
|
||||
| API | 3002 | Express.js REST API |
|
||||
| Brace Generator | 8002 | FastAPI + PyTorch |
|
||||
|
||||
## Environment Variables
|
||||
|
||||
See `.env.example` for available configuration options.
|
||||
|
||||
## License
|
||||
|
||||
Proprietary - All rights reserved.
|
||||
Reference in New Issue
Block a user