FactuGES_ERP/README.md

61 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2026-07-06 15:47:05 +00:00
# ERP Monorepo
Monorepo del ERP con aplicaciones, módulos de dominio y paquetes compartidos.
2026-07-06 15:47:05 +00:00
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).
2026-07-06 15:47:05 +00:00
## Estructura
2026-07-06 15:47:05 +00:00
```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
```
2026-07-06 15:47:05 +00:00
Áreas principales del workspace:
2026-07-06 15:47:05 +00:00
- `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`.
2026-07-06 15:47:05 +00:00
## 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.