52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
# TFM aInventory (2026)
|
|
|
|
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)
|
|
|
|
```bash
|
|
git clone <repository-url> tfm-inventory
|
|
cd tfm-inventory
|
|
|
|
# Configuration
|
|
for f in config/*.yaml.example; do cp "$f" "${f%.example}"; done
|
|
# Edit config/secrets.yaml with your keys
|
|
nano config/secrets.yaml
|
|
|
|
# Deploy
|
|
python3 scripts/deploy.py production
|
|
```
|
|
|
|
- **Frontend**: http://localhost:3000
|
|
- **Backend API**: http://localhost:8000/docs
|
|
|
|
---
|
|
|
|
## 🏗 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.
|
|
|
|
---
|
|
**Current Version**: 1.15.0
|
|
**Status**: Active Development
|