david
e5e73a5a13
- Updated general requirements document to clarify its historical context and remove outdated technical details. - Revised template documentation to serve as a base for writing prompts, emphasizing its auxiliary nature. - Enhanced architecture documentation with clear distinctions between canonical and complementary documents. - Added a new document for backend prompt base to centralize common context for backend prompts. - Created a dedicated README for customer invoices, organizing current contracts, operational support, and historical context. - Improved clarity and structure in various customer invoice documents, consolidating operational semantics and referencing canonical sources.
61 lines
1.6 KiB
Markdown
61 lines
1.6 KiB
Markdown
# ERP Monorepo
|
|
|
|
Monorepo del ERP con aplicaciones, módulos de dominio y paquetes compartidos.
|
|
|
|
El `README` raíz actúa como puerta de entrada del repositorio. La documentación funcional, operativa y arquitectónica vive en [`docs/README.md`](./docs/README.md).
|
|
|
|
## Estructura
|
|
|
|
```text
|
|
apps/ aplicaciones ejecutables
|
|
modules/ módulos de negocio y backend
|
|
packages/ librerías compartidas
|
|
docs/ documentación operativa y arquitectónica
|
|
scripts/ utilidades de desarrollo
|
|
tools/ herramientas auxiliares del workspace
|
|
```
|
|
|
|
Áreas principales del workspace:
|
|
|
|
- `apps/web`: frontend principal del ERP.
|
|
- `apps/server`: runtime servidor del monorepo.
|
|
- `modules/*`: módulos como `identity`, `companies`, `customer-invoices` o `document-series`.
|
|
- `packages/*`: utilidades compartidas como `rdx-ddd`, `rdx-utils`, `rdx-ui` e `i18n`.
|
|
|
|
## Requisitos
|
|
|
|
- Node.js `>= 24`
|
|
- PNPM `10.33.0`
|
|
|
|
## Primeros pasos
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm dev
|
|
```
|
|
|
|
Comandos frecuentes:
|
|
|
|
```bash
|
|
pnpm dev:server
|
|
pnpm dev:client
|
|
pnpm lint
|
|
pnpm check
|
|
pnpm typecheck
|
|
pnpm build
|
|
```
|
|
|
|
## Documentación
|
|
|
|
- Índice general: [`docs/README.md`](./docs/README.md)
|
|
- Frontend: [`apps/web/README.md`](./apps/web/README.md)
|
|
- Identity: [`modules/identity/README.md`](./modules/identity/README.md)
|
|
- Companies: [`modules/companies/README.md`](./modules/companies/README.md)
|
|
- Auth legacy: [`modules/auth/README.md`](./modules/auth/README.md)
|
|
|
|
## Forma de uso
|
|
|
|
- Usa este `README` para orientarte en el repositorio y arrancar el entorno.
|
|
- Usa `docs/` para contratos, decisiones de arquitectura, migraciones y runbooks.
|
|
- Usa los `README` de cada app o módulo para detalles locales de implementación.
|