docs: comprehensive cleanup and restructuring of project documentation
This commit is contained in:
67
README.md
67
README.md
@@ -1,60 +1,51 @@
|
||||
# TFM aInventory (2026 Edition)
|
||||
# TFM aInventory (2026)
|
||||
|
||||
A unified, offline-first Inventory Management System built as a Progressive Web App (PWA). Features include AI-powered label extraction (OCR), local barcode/QR scanning, and multi-user authentication with LDAP support.
|
||||
A unified, offline-first Inventory Management System built as a Progressive Web App (PWA).
|
||||
**Premium Industrial Fidelity | AI-Powered Extraction | Enterprise Sync**
|
||||
|
||||
---
|
||||
|
||||
## 📖 Project Documentation
|
||||
|
||||
### For End-Users
|
||||
- **[USER_GUIDE.md](USER_GUIDE.md)**: Manual for field operators and inventory managers.
|
||||
|
||||
### For Developers & AI Agents
|
||||
- **[AI_MANDATES.md](AI_MANDATES.md)**: **CRITICAL** operational rules for AI agents.
|
||||
- **[DESIGN_SYSTEM.md](DESIGN_SYSTEM.md)**: UI/UX standards, colors, and typography.
|
||||
- **[CODING_STANDARDS.md](CODING_STANDARDS.md)**: Programming rules, testing targets, and security.
|
||||
- **[ARCHITECTURE.md](ARCHITECTURE.md)**: Technical logic, sync patterns, and tech stack.
|
||||
- **[DEPLOYMENT.md](DEPLOYMENT.md)**: Server setup, Docker, and environment configuration.
|
||||
- **[ROADMAP.md](ROADMAP.md)**: Project history and active planning.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start (Production)
|
||||
|
||||
For production environments, Docker is the recommended deployment method:
|
||||
|
||||
```bash
|
||||
git clone <repository-url> tfm-inventory
|
||||
cd tfm-inventory
|
||||
|
||||
# [D-08] Configuration - Copy examples to actual config files
|
||||
# Configuration
|
||||
for f in config/*.yaml.example; do cp "$f" "${f%.example}"; done
|
||||
|
||||
# Edit config/secrets.yaml with your JWT_SECRET_KEY and AI keys
|
||||
# Edit config/secrets.yaml with your keys
|
||||
nano config/secrets.yaml
|
||||
|
||||
# Deploy using the new Python deployment script
|
||||
# Deploy
|
||||
python3 scripts/deploy.py production
|
||||
```
|
||||
|
||||
- **Frontend**: http://localhost:3000 (or https://localhost:8919 via proxy)
|
||||
- **Frontend**: http://localhost:3000
|
||||
- **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)**.
|
||||
|
||||
---
|
||||
|
||||
## 🏗 Technical Overview
|
||||
* **Backend:** FastAPI (Python 3.12+)
|
||||
* **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)**.
|
||||
## 🏗 Key Features
|
||||
- **Offline-First**: Continuous operation without network; background sync via IndexedDB.
|
||||
- **AI OCR**: Intelligent label extraction using Gemini & Claude.
|
||||
- **Enterprise Ready**: LDAP authentication, immutable audit logs, and SQLite WAL mode.
|
||||
- **PWA**: Installable on any mobile device.
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Security & Constraints
|
||||
AI agents and developers MUST strictly follow the rules defined in **[AI_RULES.md](AI_RULES.md)**.
|
||||
|
||||
- **No Uppercase UI**: All labels/headers must be normal case.
|
||||
- **No Bold Fonts**: Text hierarchy is achieved through size and color.
|
||||
- **Offline-First**: All features must function without an active network connection.
|
||||
|
||||
---
|
||||
|
||||
## 📦 Production Distribution
|
||||
To generate a clean production package:
|
||||
`python3 scripts/save_version.py --patch` (or `--minor`/`--major`)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2026-04-25
|
||||
**Version**: 1.14.25 (Phase 7.1)
|
||||
**Current Version**: 1.15.0
|
||||
**Status**: Active Development
|
||||
|
||||
Reference in New Issue
Block a user