diff --git a/README.md b/README.md index a5978c3..58c2e80 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Kindred Silo is an R&D-oriented item database with: - **Role-based access control** (admin > editor > viewer) with API tokens and sessions - **ODS import/export** for items, BOMs, and project sheets - **Audit/completeness scoring** with weighted per-category property validation -- **Web UI** with htmx-based item browser, project management, and schema editing +- **Web UI** — React SPA (Vite + TypeScript, Catppuccin Mocha theme) for item browsing, project management, schema editing, and audit - **CAD integration** via REST API ([silo-mod](https://git.kindred-systems.com/kindred/silo-mod), [silo-calc](https://git.kindred-systems.com/kindred/silo-calc)) - **Physical inventory** tracking with hierarchical locations (schema ready) @@ -22,24 +22,33 @@ Kindred Silo is an R&D-oriented item database with: ``` silo/ ├── cmd/ -│ ├── silo/ # CLI tool -│ └── silod/ # API server +│ ├── silo/ # CLI tool +│ └── silod/ # API server ├── internal/ -│ ├── api/ # HTTP handlers, routes, templates (76 endpoints) -│ ├── auth/ # Authentication (local, LDAP, OIDC) -│ ├── config/ # Configuration loading -│ ├── db/ # PostgreSQL repositories -│ ├── migration/ # Property migration utilities -│ ├── odoo/ # Odoo ERP integration -│ ├── ods/ # ODS spreadsheet library -│ ├── partnum/ # Part number generation -│ ├── schema/ # YAML schema parsing -│ └── storage/ # MinIO file storage -├── migrations/ # Database migrations (10 files) -├── schemas/ # Part numbering schemas (YAML) -├── deployments/ # Docker Compose and systemd configs -├── scripts/ # Deployment and setup scripts -└── docs/ # Documentation +│ ├── api/ # HTTP handlers and routes (75 endpoints) +│ ├── auth/ # Authentication (local, LDAP, OIDC) +│ ├── config/ # Configuration loading +│ ├── db/ # PostgreSQL repositories +│ ├── migration/ # Property migration utilities +│ ├── odoo/ # Odoo ERP integration +│ ├── ods/ # ODS spreadsheet library +│ ├── partnum/ # Part number generation +│ ├── schema/ # YAML schema parsing +│ ├── storage/ # MinIO file storage +│ └── testutil/ # Test helpers +├── web/ # React SPA (Vite + TypeScript) +│ └── src/ +│ ├── api/ # API client and type definitions +│ ├── components/ # Reusable UI components +│ ├── context/ # Auth context provider +│ ├── hooks/ # Custom React hooks +│ ├── pages/ # Page components (Items, Projects, Schemas, Settings, Audit, Login) +│ └── styles/ # Catppuccin Mocha theme and global styles +├── migrations/ # Database migrations (11 files) +├── schemas/ # Part numbering schemas (YAML) +├── deployments/ # Docker Compose and systemd configs +├── scripts/ # Deployment and setup scripts +└── docs/ # Documentation ``` ## Quick Start @@ -95,12 +104,16 @@ The server provides the REST API and ODS endpoints consumed by these clients. | Document | Description | |----------|-------------| -| [docs/AUTH.md](docs/AUTH.md) | Authentication system design | -| [docs/AUTH_USER_GUIDE.md](docs/AUTH_USER_GUIDE.md) | User guide for login, tokens, and roles | -| [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) | Production deployment guide | | [docs/SPECIFICATION.md](docs/SPECIFICATION.md) | Full design specification and API reference | | [docs/STATUS.md](docs/STATUS.md) | Implementation status | -| [ROADMAP.md](ROADMAP.md) | Feature roadmap and gap analysis | +| [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) | Production deployment guide | +| [docs/CONFIGURATION.md](docs/CONFIGURATION.md) | Configuration reference (all `config.yaml` options) | +| [docs/AUTH.md](docs/AUTH.md) | Authentication system design | +| [docs/AUTH_USER_GUIDE.md](docs/AUTH_USER_GUIDE.md) | User guide for login, tokens, and roles | +| [docs/GAP_ANALYSIS.md](docs/GAP_ANALYSIS.md) | Gap analysis and revision control roadmap | +| [docs/COMPONENT_AUDIT.md](docs/COMPONENT_AUDIT.md) | Component audit tool design | +| [ROADMAP.md](ROADMAP.md) | Feature roadmap and SOLIDWORKS PDM comparison | +| [frontend-spec.md](frontend-spec.md) | React SPA frontend specification | ## License