Files
motovaultpro/docs/README.md
Eric Gullickson 197927ef31
All checks were successful
Deploy to Staging / Build Images (pull_request) Successful in 4m37s
Deploy to Staging / Deploy to Staging (pull_request) Successful in 29s
Deploy to Staging / Verify Staging (pull_request) Successful in 7s
Deploy to Staging / Notify Staging Ready (pull_request) Successful in 7s
Deploy to Staging / Notify Staging Failure (pull_request) Has been skipped
test: add integration tests and documentation (refs #26)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-11 20:05:06 -06:00

36 lines
2.0 KiB
Markdown

# MotoVaultPro Documentation
Project documentation hub for the 5-container single-tenant architecture with integrated platform feature.
## Navigation
- Architecture: `docs/PLATFORM-SERVICES.md`
- Security: `docs/SECURITY.md`
- Vehicles API (authoritative): `docs/VEHICLES-API.md`
- Database schema: `docs/DATABASE-SCHEMA.md`
- Testing (containers only): `docs/TESTING.md`
- Database Migration: `docs/DATABASE-MIGRATION.md`
- Development Environment: `docker-compose.yml`
- Application features (start at each README):
- `backend/src/features/admin/README.md` - Admin role management and oversight
- `backend/src/features/auth/README.md` - User signup and email verification
- `backend/src/features/backup/README.md` - Database backup and restore
- `backend/src/features/documents/README.md` - Document storage and management
- `backend/src/features/fuel-logs/README.md` - Fuel consumption tracking
- `backend/src/features/maintenance/README.md` - Maintenance records
- `backend/src/features/notifications/README.md` - Email and toast notifications
- `backend/src/features/onboarding/README.md` - User onboarding flow
- `backend/src/features/platform/README.md` - Vehicle data and VIN decoding
- `backend/src/features/stations/README.md` - Gas station search and favorites (Google Maps integration)
- `backend/src/features/terms-agreement/README.md` - Terms & Conditions acceptance audit
- `backend/src/features/user-export/README.md` - User data export (GDPR)
- `backend/src/features/user-import/README.md` - User data import (restore from backup, migration)
- `backend/src/features/user-preferences/README.md` - User preference settings
- `backend/src/features/user-profile/README.md` - User profile management
- `backend/src/features/vehicles/README.md` - User vehicle management
## Notes
- Canonical URLs: Frontend `https://motovaultpro.com`, Backend health `https://motovaultpro.com/api/health`.
- All 15 features have comprehensive test suites (unit + integration tests).