docs(07-04): update README.md for Phase 7 config structure
This commit is contained in:
22
README.md
22
README.md
@@ -11,14 +11,21 @@ For production environments, Docker is the recommended deployment method:
|
||||
```bash
|
||||
git clone <repository-url> tfm-inventory
|
||||
cd tfm-inventory
|
||||
cp inventory.env.example inventory.env
|
||||
# Edit inventory.env with your JWT_SECRET_KEY and AI keys
|
||||
./deploy.sh production
|
||||
|
||||
# [D-08] Configuration - Copy examples to actual config files
|
||||
for f in config/*.yaml.example; do cp "$f" "${f%.example}"; done
|
||||
|
||||
# Edit config/secrets.yaml with your JWT_SECRET_KEY and AI keys
|
||||
nano config/secrets.yaml
|
||||
|
||||
# Deploy using the new Python deployment script
|
||||
python3 scripts/deploy.py production
|
||||
```
|
||||
|
||||
- **Frontend**: http://localhost:8917 (or https://localhost:8909 via proxy)
|
||||
- **Backend API**: http://localhost:8916/docs
|
||||
- **Frontend**: http://localhost:3000 (or https://localhost:8919 via proxy)
|
||||
- **Backend API**: http://localhost:8000/docs
|
||||
|
||||
For detailed configuration reference, see **[config/README.md](config/README.md)**.
|
||||
For detailed deployment instructions (Docker vs Standalone), see **[DEPLOYMENT.md](DEPLOYMENT.md)**.
|
||||
|
||||
---
|
||||
@@ -28,6 +35,7 @@ For detailed deployment instructions (Docker vs Standalone), see **[DEPLOYMENT.m
|
||||
* **Frontend:** Next.js 15+ (React PWA) with responsive Tailwind CSS
|
||||
* **Database:** SQLite (SQLAlchemy) with Dexie.js (IndexedDB) for client-side sync.
|
||||
* **AI Engine:** Google Gemini (Primary) & Anthropic Claude (Fallback).
|
||||
* **Configuration:** [D-07] Consolidated YAML-based config in `config/` directory.
|
||||
|
||||
For more details on system logic, see **[PROJECT_ARCHITECTURE.md](PROJECT_ARCHITECTURE.md)**.
|
||||
|
||||
@@ -48,5 +56,5 @@ To generate a clean production package:
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2026-04-23
|
||||
**Version**: 1.14.6
|
||||
**Last Updated**: 2026-05-15
|
||||
**Version**: 1.15.0 (Phase 7)
|
||||
|
||||
Reference in New Issue
Block a user