egullickson/motovaultpro
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: Update Documentation
All checks were successful
Deploy to Staging / Build Images (push) Successful in 2m19s
Details
Deploy to Staging / Deploy to Staging (push) Successful in 27s
Details
Deploy to Staging / Verify Staging (push) Successful in 5s
Details
Deploy to Staging / Notify Staging Ready (push) Successful in 5s
Details
Deploy to Staging / Notify Staging Failure (push) Has been skipped
Details
Mirror Base Images / Mirror Base Images (push) Successful in 29s
Details

Browse Source
This commit is contained in:
Eric Gullickson
2026-01-03 15:10:19 -06:00
parent 485bfd3dfc
commit 3053b62fa5
8 changed files with 1149 additions and 273 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/README.md
View File

@@ -10,18 +10,25 @@ Project documentation hub for the 5-container single-tenant architecture with in
- Database schema: `docs/DATABASE-SCHEMA.md`
- Testing (containers only): `docs/TESTING.md`
- Database Migration: `docs/DATABASE-MIGRATION.md`
- Admin feature: `docs/ADMIN.md` - Role management, APIs, catalog CRUD, station oversight
- 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/platform/README.md` - Vehicle data and VIN decoding
- `backend/src/features/vehicles/README.md` - User vehicle management
- `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/documents/README.md` - Document storage and management
- `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-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 7 features have comprehensive test suites (unit + integration tests).
- All 15 features have comprehensive test suites (unit + integration tests).