feat: update docs for token efficient usage
Some checks failed
Deploy to Staging / Build Images (push) Has started running
Deploy to Staging / Deploy to Staging (push) Has been cancelled
Deploy to Staging / Verify Staging (push) Has been cancelled
Deploy to Staging / Notify Staging Ready (push) Has been cancelled
Deploy to Staging / Notify Staging Failure (push) Has been cancelled

This commit is contained in:
Eric Gullickson
2026-01-03 11:59:47 -06:00
parent 3dd86c37ff
commit b933329539
19 changed files with 333 additions and 71 deletions

View File

@@ -1,3 +1,47 @@
# MotoVaultPro
Single-tenant vehicle management application with 5-container architecture (Traefik, Frontend, Backend, PostgreSQL, Redis).
## Files
| File | What | When to read |
| ---- | ---- | ------------ |
| `Makefile` | Build, test, deploy commands | Running any make command |
| `docker-compose.yml` | Development container orchestration | Local development setup |
| `package.json` | Root workspace dependencies | Dependency management |
| `README.md` | Project overview | First-time setup |
## Subdirectories
| Directory | What | When to read |
| --------- | ---- | ------------ |
| `backend/` | Fastify API server with feature capsules | Backend development |
| `frontend/` | React/Vite SPA with MUI | Frontend development |
| `docs/` | Project documentation hub | Architecture, APIs, testing |
| `config/` | Configuration files (Traefik, monitoring) | Infrastructure setup |
| `scripts/` | Utility scripts (backup, deploy) | Automation tasks |
| `.ai/` | AI context and workflow contracts | AI-assisted development |
| `.claude/` | Claude Code agents and skills | Delegating to agents, using skills |
| `.gitea/` | Gitea workflows and templates | CI/CD, issue templates |
| `ansible/` | Ansible deployment playbooks | Server provisioning |
## Build
```bash
make setup # First-time setup (builds containers, runs migrations)
make rebuild # Rebuild containers after changes
```
## Test
```bash
npm test # Run all tests
npm run lint # Linting
npm run type-check # TypeScript validation
```
---
# Development Partnership Guidelines
## Core Development Principles