Documentación para desarrolladores
Esta sección documenta cómo está construido cada módulo. Todo el contenido se contrasta con el código de allendostmen-erp-server (Laravel) y allendostmen-erp-web (Angular).
Referencia de API
Sección titulada «Referencia de API»La referencia de API explica la autenticación, la paginación y los errores, y documenta cada endpoint por módulo y por modelo.
Módulos documentados
Sección titulada «Módulos documentados»| Módulo | Contenido |
|---|---|
| Caja | Arquitectura, permisos, reglas de conciliación y exportación. Sus endpoints están en la referencia de API. |
Antes de empezar
Sección titulada «Antes de empezar»Las reglas de oro del proyecto viven en AGENTS.md. Las más relevantes para el backend:
- Todo modelo usa
BaseModelTrait(SoftDeletes, auditoría y scopes). - Los controllers delegan en
BaseControllerHelper. - Los estados se manejan con
ModelStatusEnum, nunca con textos sueltos. - Cada modelo tiene su Policy y sus Requests
Store*yUpdate*. - Los permisos se consultan con el enum del módulo (
XPermission::Accion->fullKey()).
