#29 docs: add project analysis to AGENTS.md
This commit is contained in:
33
AGENTS.md
33
AGENTS.md
@@ -19,6 +19,11 @@ src/
|
|||||||
├── plugins/ # Configuración de Vuetify, etc.
|
├── plugins/ # Configuración de Vuetify, etc.
|
||||||
├── router/ # Configuración de rutas
|
├── router/ # Configuración de rutas
|
||||||
├── services/ # API services (auth.js, etc.)
|
├── services/ # API services (auth.js, etc.)
|
||||||
|
│ ├── api.js # Clase wrapper que делегат methods
|
||||||
|
│ ├── api-implementation.js # Factory que selecciona implementación
|
||||||
|
│ ├── auth.js # Manejo de auth (login, tokens JWT)
|
||||||
|
│ ├── django-api.js # Implementación de API para Django
|
||||||
|
│ └── http.js # Axios instance con interceptors
|
||||||
├── stores/ # Pinia stores
|
├── stores/ # Pinia stores
|
||||||
└── styles/ # SCSS settings
|
└── styles/ # SCSS settings
|
||||||
```
|
```
|
||||||
@@ -51,6 +56,7 @@ import MiComponente from '@/components/MiComponente.vue';
|
|||||||
- Ubicación: `src/services/`
|
- Ubicación: `src/services/`
|
||||||
- Usar Axios para HTTP requests
|
- Usar Axios para HTTP requests
|
||||||
- JWT tokens en localStorage (`access_token`, `refresh_token`)
|
- JWT tokens en localStorage (`access_token`, `refresh_token`)
|
||||||
|
- La API se inyecta globalmente via `app.provide('api', api)` y se usa con `inject('api')`
|
||||||
|
|
||||||
### Routing
|
### Routing
|
||||||
- Rutas automáticas basadas en archivos en `src/pages/`
|
- Rutas automáticas basadas en archivos en `src/pages/`
|
||||||
@@ -79,3 +85,30 @@ npm run lint # ESLint fix
|
|||||||
**Formato de mensajes:**
|
**Formato de mensajes:**
|
||||||
- Usar prefijo `#<numero>` para referenciar el issue (ej: `#28 feat: add login` donde #28 es el número del issue en GitHub/GitLab)
|
- Usar prefijo `#<numero>` para referenciar el issue (ej: `#28 feat: add login` donde #28 es el número del issue en GitHub/GitLab)
|
||||||
- Prefijos válidos: `feat`, `fix`, `chore`, `docs`, `refactor`, `style`
|
- Prefijos válidos: `feat`, `fix`, `chore`, `docs`, `refactor`, `style`
|
||||||
|
|
||||||
|
## Análisis del Proyecto
|
||||||
|
|
||||||
|
### Flujo de Autenticación
|
||||||
|
1. **Login:** `AuthService.login(credentials)` → obtiene JWT tokens → guarda en localStorage
|
||||||
|
2. **Token:** Se envía en headers via interceptor en `http.js` (`Authorization: Bearer <token>`)
|
||||||
|
3. **Refresh:** El interceptor renueva automáticamente el token si expira (401)
|
||||||
|
4. **Logout:** `AuthService.logout()` → limpia localStorage
|
||||||
|
|
||||||
|
### Estructura de API
|
||||||
|
- `api.js`: Interfaz genérica con métodos como `getCustomers()`, `getProducts()`, etc.
|
||||||
|
- `api-implementation.js`: Factory que selecciona implementación (actualmente solo Django)
|
||||||
|
- `django-api.js`: Implementación concreta con endpoints de Django
|
||||||
|
|
||||||
|
### Componentes Principales
|
||||||
|
- **NavBar.vue**: Barra de navegación con menú de usuario
|
||||||
|
- **LoginDialog.vue**: Diálogo de inicio de sesión
|
||||||
|
- **Purchase.vue / AdminPurchase.vue**: Componentes de compra
|
||||||
|
- **Cart.vue**: Carrito de compras
|
||||||
|
- **SummaryPurchase.vue**: Resumen de compra
|
||||||
|
|
||||||
|
### Endpoints Django Comunes
|
||||||
|
- `/api/token/` - Autenticación (login/refresh)
|
||||||
|
- `/users/me/` - Usuario actual
|
||||||
|
- `/don_confiao/api/customers/` - Clientes
|
||||||
|
- `/don_confiao/api/products/` - Productos
|
||||||
|
- `/don_confiao/api/sales/` - Ventas
|
||||||
|
|||||||
Reference in New Issue
Block a user