Added Documents Feature
This commit is contained in:
34
frontend/README.md
Normal file
34
frontend/README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Frontend Quickload
|
||||
|
||||
## Overview
|
||||
- Tech: React 18, Vite, TypeScript, MUI, Tailwind, React Query, Zustand.
|
||||
- Auth: Auth0 via `src/core/auth/Auth0Provider.tsx`.
|
||||
- Data: API client in `src/core/api/client.ts` with React Query config.
|
||||
|
||||
## Commands (containers)
|
||||
- Build: `make rebuild`
|
||||
- Tests: `make test-frontend`
|
||||
- Logs: `make logs-frontend`
|
||||
|
||||
## Structure
|
||||
- `src/App.tsx`, `src/main.tsx` — app entry.
|
||||
- `src/features/*` — feature pages/components/hooks.
|
||||
- `src/core/*` — auth, api, store, hooks, query config, utils.
|
||||
- `src/shared-minimal/*` — shared UI components and theme.
|
||||
|
||||
## Mobile + Desktop (required)
|
||||
- Layouts responsive by default; validate on small/large viewports.
|
||||
- Verify Suspense fallbacks and navigation flows on both form factors.
|
||||
- Test key screens: Vehicles, Fuel Logs, Documents, Settings.
|
||||
- Ensure touch interactions and keyboard navigation work equivalently.
|
||||
|
||||
## Testing
|
||||
- Jest config: `frontend/jest.config.ts` (jsdom).
|
||||
- Setup: `frontend/setupTests.ts` (Testing Library).
|
||||
- Run: `make test-frontend` (containerized).
|
||||
|
||||
## Patterns
|
||||
- State: co-locate feature state in `src/core/store` (Zustand) and React Query for server state.
|
||||
- Forms: `react-hook-form` + Zod resolvers.
|
||||
- UI: MUI components; Tailwind for utility styling.
|
||||
|
||||
Reference in New Issue
Block a user