Resolve the operational/config sprawl (#10-#14 from the review): the app read NORMOGEN_*/MONGODB_* env vars but every env/compose file set SERVER_*/DATABASE_*, the ports were all over the place (8080/8000/6500/6800), there were 5 inconsistent Dockerfiles (rust:1.82 vs rust:1.93, missing curl), and an 18 MB binary was committed. Env-var names — standardize on what the code reads: * config/mod.rs: NORMOGEN_PORT default 8080 -> 6500 (avoid the over-common 8000/8080). * db/mod.rs: create_database() now reads MONGODB_DATABASE (was DATABASE_NAME). * .env.example, defaults.env, docker-compose.yml, docker-compose.dev.yml, DEPLOYMENT_GUIDE.md, deployment/README.md, deploy-and-test-solaria.sh, deploy-local-build.sh: use NORMOGEN_HOST/NORMOGEN_PORT/MONGODB_URI/ MONGODB_DATABASE/APP_ENVIRONMENT; drop the dead SERVER_*/DATABASE_URI/ DATABASE_NAME names. Ports — canonical container port 6500 everywhere: * Both Dockerfiles EXPOSE 6500; prod compose maps 6500:6500, dev 6501:6500. * Bulk-replaced the long tail of solaria:8000/localhost:8000/localhost:8080 in docs and test scripts -> 6500. Dockerfiles — 2 canonical, rust:latest, curl + healthcheck: * backend/Dockerfile (prod): rust:latest builder, debian runtime now installs curl (so the compose HEALTHCHECK actually works), EXPOSE 6500. * backend/docker/Dockerfile.dev (dev): rust:latest both stages, EXPOSE 6500. * Deleted 3 redundant Dockerfiles (Dockerfile.improved x2, docker/Dockerfile). * Deleted the committed 18 MB binary backend/docker/normogen-backend. * Deleted 2 stray fix-notes in backend/docker/. Compose: * docker-compose.yml: correct env names, 6500:6500, APP_ENVIRONMENT=production, JWT_SECRET/ENCRYPTION_KEY required via compose interpolation, dropped the obsolete top-level version: key. * docker-compose.dev.yml: correct env names, 6501:6500, mongo:7 (was 6.0), added a working backend healthcheck. * Deleted docker/docker-compose.improved.yml + backend/deploy-to-solaria-improved.sh (built around the now-deleted 'improved' Docker files). Verified: cargo fmt --check clean, build + clippy --all-targets clean, 18 unit tests pass; grep confirms no SERVER_*/DATABASE_* env names and no rust:1.x tags remain outside docs/archive and docs/adr (historical).
58 lines
2.1 KiB
Markdown
58 lines
2.1 KiB
Markdown
# Normogen
|
|
|
|
**Normogen** (Mapudungun for "Balanced Life") is an open-source health data platform for private, secure health data management.
|
|
|
|
## 📚 Documentation
|
|
|
|
All project documentation has been organized into the `docs/` directory:
|
|
|
|
- **[Documentation Index](./docs/README.md)** - Start here for complete documentation
|
|
- **[Product Overview](./docs/product/README.md)** - Project introduction and features
|
|
- **[Quick Start](./docs/product/README.md#quick-start)** - Get started quickly
|
|
- **[API Documentation](./docs/product/README.md#backend-api-endpoints)** - Backend API reference
|
|
|
|
## 🚀 Quick Start
|
|
|
|
```bash
|
|
# Clone repository
|
|
git clone <forgejo-url> normogen
|
|
cd normogen/backend
|
|
|
|
# Setup configuration
|
|
cp .env.example .env
|
|
# Edit .env with your values
|
|
|
|
# Run with Docker Compose
|
|
docker compose up -d
|
|
|
|
# Check status (default port is 6500 via NORMOGEN_PORT; Solaria maps it to host 6800)
|
|
curl http://localhost:6500/health
|
|
```
|
|
|
|
## 📊 Current Status
|
|
|
|
- **Backend**: ✅ Phase 2.x feature-complete (Rust + Axum + MongoDB), including drug interactions (Phase 2.8). Security-hardened: token-version validation, hashed refresh-token persistence, fail-fast config, real-IP audit logging. Deployed on Solaria.
|
|
- **Frontend**: 🚧 Early (React + TypeScript) — Login/Register pages + API/store layer exist; router not yet wired.
|
|
- **Tests**: 18 unit + 13 integration (auth + medication), CI-gated with MongoDB.
|
|
- **Deployment**: Docker on Solaria (image built manually — CI can't run DinD on Forgejo).
|
|
- See [docs/product/STATUS.md](./docs/product/STATUS.md) for the full breakdown.
|
|
|
|
## 🗂️ Documentation Structure
|
|
|
|
```
|
|
docs/
|
|
├── product/ # Product definition, features, roadmap
|
|
├── implementation/ # Phase plans, specs, progress reports
|
|
├── testing/ # Test scripts and results
|
|
├── deployment/ # Deployment guides and scripts
|
|
├── development/ # Git workflow, CI/CD, development tools
|
|
└── archive/ # Historical documentation
|
|
```
|
|
|
|
## 📖 Full Documentation
|
|
|
|
See the [Documentation Index](./docs/README.md) for complete project documentation.
|
|
|
|
---
|
|
|
|
*Last Updated: 2026-06-27*
|