chore: Update Documentation
All checks were successful
Deploy to Staging / Build Images (push) Successful in 2m19s
Deploy to Staging / Deploy to Staging (push) Successful in 27s
Deploy to Staging / Verify Staging (push) Successful in 5s
Deploy to Staging / Notify Staging Ready (push) Successful in 5s
Deploy to Staging / Notify Staging Failure (push) Has been skipped
Mirror Base Images / Mirror Base Images (push) Successful in 29s
All checks were successful
Deploy to Staging / Build Images (push) Successful in 2m19s
Deploy to Staging / Deploy to Staging (push) Successful in 27s
Deploy to Staging / Verify Staging (push) Successful in 5s
Deploy to Staging / Notify Staging Ready (push) Successful in 5s
Deploy to Staging / Notify Staging Failure (push) Has been skipped
Mirror Base Images / Mirror Base Images (push) Successful in 29s
This commit is contained in:
@@ -240,12 +240,21 @@ Features are **self-contained modules** within the backend service at `backend/s
|
||||
|
||||
```
|
||||
backend/src/features/
|
||||
├── vehicles/ # Vehicle management
|
||||
├── fuel-logs/ # Fuel tracking
|
||||
├── maintenance/ # Service records
|
||||
├── stations/ # Gas station locations
|
||||
├── admin/ # Admin role management
|
||||
├── auth/ # User authentication
|
||||
├── backup/ # Database backup/restore
|
||||
├── documents/ # Document storage
|
||||
└── platform/ # Vehicle data + VIN decoding
|
||||
├── fuel-logs/ # Fuel tracking
|
||||
├── maintenance/ # Service records and schedules
|
||||
├── notifications/ # Email and toast notifications
|
||||
├── onboarding/ # User onboarding flow
|
||||
├── platform/ # Vehicle data + VIN decoding
|
||||
├── stations/ # Gas station locations
|
||||
├── terms-agreement/ # T&C acceptance audit
|
||||
├── user-export/ # GDPR data export
|
||||
├── user-preferences/ # User settings
|
||||
├── user-profile/ # User profile management
|
||||
└── vehicles/ # Vehicle management
|
||||
```
|
||||
|
||||
### Feature Structure
|
||||
@@ -262,13 +271,30 @@ feature-name/
|
||||
└── external/ # External service integrations (optional)
|
||||
```
|
||||
|
||||
### Current Features
|
||||
### Current Features (15)
|
||||
|
||||
#### Vehicles
|
||||
- **Purpose**: Vehicle inventory management
|
||||
- **Tables**: `vehicles` (user-scoped)
|
||||
- **Integration**: Platform service for make/model/trim data
|
||||
- **Endpoints**: CRUD + dropdown data
|
||||
#### Admin
|
||||
- **Purpose**: Admin role management and oversight
|
||||
- **Tables**: `admin_users`, `admin_audit_logs`
|
||||
- **Endpoints**: Admin CRUD, catalog management, station oversight
|
||||
|
||||
#### Auth
|
||||
- **Purpose**: User authentication and signup
|
||||
- **Tables**: None (uses Auth0)
|
||||
- **Integration**: Auth0 for identity management
|
||||
- **Endpoints**: Signup, verify email, resend verification
|
||||
|
||||
#### Backup
|
||||
- **Purpose**: Database and document backup/restore
|
||||
- **Tables**: `backup_schedules`, `backup_history`, `backup_settings`
|
||||
- **Storage**: `/app/data/backups/`
|
||||
- **Endpoints**: Admin backup CRUD, restore, schedules
|
||||
|
||||
#### Documents
|
||||
- **Purpose**: Document storage and retrieval
|
||||
- **Tables**: `documents` (user-scoped)
|
||||
- **Storage**: Filesystem (`/app/data/documents/`)
|
||||
- **Endpoints**: Upload + download + delete
|
||||
|
||||
#### Fuel Logs
|
||||
- **Purpose**: Fuel purchase and efficiency tracking
|
||||
@@ -278,21 +304,61 @@ feature-name/
|
||||
|
||||
#### Maintenance
|
||||
- **Purpose**: Service and maintenance record tracking
|
||||
- **Tables**: `maintenance_records` (user-scoped)
|
||||
- **Integration**: Vehicles feature for vehicle data
|
||||
- **Endpoints**: CRUD + reminders
|
||||
- **Tables**: `maintenance_logs`, `maintenance_schedules` (user-scoped)
|
||||
- **Integration**: Vehicles feature, notifications
|
||||
- **Endpoints**: CRUD + schedules + reminders
|
||||
|
||||
#### Notifications
|
||||
- **Purpose**: Email and toast notifications
|
||||
- **Tables**: `email_templates`, `notification_logs`
|
||||
- **Integration**: Resend API for email delivery
|
||||
- **Endpoints**: User summary, admin template management
|
||||
|
||||
#### Onboarding
|
||||
- **Purpose**: User onboarding after signup
|
||||
- **Tables**: Uses `user_profiles`, `user_preferences`
|
||||
- **Integration**: User profile and preferences features
|
||||
- **Endpoints**: Preferences, complete, status
|
||||
|
||||
#### Platform
|
||||
- **Purpose**: Vehicle data and VIN decoding
|
||||
- **Tables**: `engines`, `transmissions`, `vehicle_options`
|
||||
- **Integration**: Backend dropdown cascade queries
|
||||
- **Endpoints**: Years, makes, models, trims, engines
|
||||
|
||||
#### Stations
|
||||
- **Purpose**: Gas station location and pricing
|
||||
- **Tables**: `stations` (user-scoped)
|
||||
- **Tables**: `stations`, `community_stations`
|
||||
- **Integration**: Google Maps API
|
||||
- **Endpoints**: Search + favorites
|
||||
- **Endpoints**: Search + favorites + community reports
|
||||
|
||||
#### Documents
|
||||
- **Purpose**: Document storage and retrieval
|
||||
- **Tables**: `documents` (user-scoped)
|
||||
- **Storage**: Filesystem (`/app/data/documents/`)
|
||||
- **Endpoints**: Upload + download + delete
|
||||
#### Terms Agreement
|
||||
- **Purpose**: Legal audit trail for T&C acceptance
|
||||
- **Tables**: `terms_agreements`
|
||||
- **Integration**: Created during signup flow
|
||||
- **Endpoints**: None (internal use)
|
||||
|
||||
#### User Export
|
||||
- **Purpose**: GDPR-compliant data export
|
||||
- **Tables**: None (reads from all user data)
|
||||
- **Storage**: Temporary TAR.GZ archives
|
||||
- **Endpoints**: Export download
|
||||
|
||||
#### User Preferences
|
||||
- **Purpose**: User preference management
|
||||
- **Tables**: `user_preferences` (user-scoped)
|
||||
- **Endpoints**: GET/PUT preferences
|
||||
|
||||
#### User Profile
|
||||
- **Purpose**: User profile management
|
||||
- **Tables**: `user_profiles` (user-scoped)
|
||||
- **Endpoints**: GET/PUT profile
|
||||
|
||||
#### Vehicles
|
||||
- **Purpose**: Vehicle inventory management
|
||||
- **Tables**: `vehicles` (user-scoped)
|
||||
- **Integration**: Platform service for make/model/trim data
|
||||
- **Endpoints**: CRUD + dropdown data + images
|
||||
|
||||
## Data Flow
|
||||
|
||||
|
||||
Reference in New Issue
Block a user