rckrdmrd
928eb795e6
- HERENCIA-SIMCO.md actualizado con directivas v3.7 y v3.8 - Cambios en backend y frontend Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
176 lines
5.8 KiB
Markdown
176 lines
5.8 KiB
Markdown
# Indice de Documentacion de Arquitectura
|
|
|
|
**Proyecto:** MiChangarrito
|
|
**Fecha:** 2026-01-10
|
|
**Version:** 1.0.0
|
|
|
|
---
|
|
|
|
## Proposito
|
|
|
|
Este documento sirve como indice navegacional para toda la documentacion de arquitectura del proyecto MiChangarrito. Facilita encontrar la informacion correcta segun el area de trabajo.
|
|
|
|
---
|
|
|
|
## Mapa de Documentos
|
|
|
|
```
|
|
docs/
|
|
├── 00-vision-general/
|
|
│ ├── VISION-PROYECTO.md # Que es MiChangarrito, propuesta de valor
|
|
│ ├── REQUERIMIENTOS-FUNCIONALES.md # Lista de funcionalidades
|
|
│ └── ARQUITECTURA-TECNICA.md # Stack, componentes, diagrama general
|
|
│
|
|
├── 01-epicas/
|
|
│ ├── _MAP.md # Indice de 28 epicas
|
|
│ └── MCH-001 a MCH-028 # Especificaciones por funcionalidad
|
|
│
|
|
├── 02-especificaciones/
|
|
│ ├── _MAP.md # Indice local
|
|
│ ├── ARQUITECTURA-DATABASE.md # Schema BD completo (FUENTE CANONICA)
|
|
│ ├── ESPECIFICACION-COMPONENTES.md # Stack y modulos
|
|
│ ├── INTEGRACIONES-EXTERNAS.md # 9 integraciones
|
|
│ ├── INVESTIGACION-REFERENCIAS.md # Codigo reutilizable
|
|
│ ├── PLAN-DESARROLLO.md # Cronograma
|
|
│ └── CALCULADORA-CAMBIO.md # Logica de cambio
|
|
│
|
|
├── 90-transversal/
|
|
│ ├── ARQUITECTURA-MULTI-TENANT-INTEGRACIONES.md # WhatsApp/LLM por tenant
|
|
│ └── GUIA-DESPLIEGUE.md # Docker, produccion
|
|
│
|
|
└── INDICE-ARQUITECTURA.md # ESTE ARCHIVO
|
|
```
|
|
|
|
---
|
|
|
|
## Ruta de Lectura Recomendada
|
|
|
|
### Para Nuevos en el Proyecto (30 min)
|
|
|
|
1. **VISION-PROYECTO.md** - Entender que es MiChangarrito
|
|
2. **ARQUITECTURA-TECNICA.md** - Ver el stack y componentes
|
|
3. **docs/_MAP.md** - Navegacion general
|
|
|
|
### Para Desarrolladores Backend
|
|
|
|
| Orden | Documento | Tiempo | Contenido |
|
|
|-------|-----------|--------|-----------|
|
|
| 1 | ARQUITECTURA-DATABASE.md | 20 min | Schema completo, 9 schemas, 27 tablas |
|
|
| 2 | ESPECIFICACION-COMPONENTES.md | 10 min | Modulos NestJS, endpoints |
|
|
| 3 | INTEGRACIONES-EXTERNAS.md | 15 min | Stripe, WhatsApp, LLM |
|
|
| 4 | ARQUITECTURA-MULTI-TENANT.md | 10 min | Credenciales por tenant |
|
|
|
|
### Para Desarrolladores Frontend
|
|
|
|
| Orden | Documento | Tiempo | Contenido |
|
|
|-------|-----------|--------|-----------|
|
|
| 1 | ESPECIFICACION-COMPONENTES.md | 10 min | Paginas, componentes React |
|
|
| 2 | CALCULADORA-CAMBIO.md | 5 min | UI/UX de cobro efectivo |
|
|
| 3 | Epicas relevantes | Variable | MCH-004 (POS), MCH-021 (Dashboard) |
|
|
|
|
### Para DevOps/Infraestructura
|
|
|
|
| Orden | Documento | Tiempo | Contenido |
|
|
|-------|-----------|--------|-----------|
|
|
| 1 | GUIA-DESPLIEGUE.md | 15 min | Docker, nginx, SSL |
|
|
| 2 | ARQUITECTURA-TECNICA.md | 10 min | Puertos, servicios |
|
|
| 3 | ARQUITECTURA-MULTI-TENANT.md | 10 min | Variables de entorno |
|
|
|
|
### Para Integraciones Externas
|
|
|
|
| Orden | Documento | Tiempo | Contenido |
|
|
|-------|-----------|--------|-----------|
|
|
| 1 | INTEGRACIONES-EXTERNAS.md | 20 min | 9 servicios documentados |
|
|
| 2 | ARQUITECTURA-MULTI-TENANT.md | 10 min | Credenciales WhatsApp/LLM |
|
|
|
|
---
|
|
|
|
## Busqueda por Tema
|
|
|
|
### Base de Datos
|
|
|
|
| Tema | Documento | Seccion |
|
|
|------|-----------|---------|
|
|
| Schema completo (SQL) | ARQUITECTURA-DATABASE.md | Todo el documento |
|
|
| Multi-tenancy RLS | ARQUITECTURA-DATABASE.md | Row Level Security |
|
|
| Convenciones columnas | ARQUITECTURA-DATABASE.md | Convenciones |
|
|
| Diagrama schemas | ARQUITECTURA-TECNICA.md | Schemas Principales |
|
|
|
|
### Integraciones
|
|
|
|
| Tema | Documento | Seccion |
|
|
|------|-----------|---------|
|
|
| Stripe (pagos) | INTEGRACIONES-EXTERNAS.md | Stripe |
|
|
| WhatsApp Business | INTEGRACIONES-EXTERNAS.md | WhatsApp |
|
|
| WhatsApp Multi-tenant | ARQUITECTURA-MULTI-TENANT.md | WhatsApp |
|
|
| LLM/OpenRouter | INTEGRACIONES-EXTERNAS.md | OpenRouter |
|
|
| LLM Multi-tenant | ARQUITECTURA-MULTI-TENANT.md | LLM |
|
|
|
|
### Componentes
|
|
|
|
| Tema | Documento | Seccion |
|
|
|------|-----------|---------|
|
|
| Modulos Backend | ESPECIFICACION-COMPONENTES.md | Modulos Backend |
|
|
| Paginas Frontend | ESPECIFICACION-COMPONENTES.md | Paginas |
|
|
| MCP Server | INTEGRACIONES-EXTERNAS.md | MCP |
|
|
| WhatsApp Service | INTEGRACIONES-EXTERNAS.md | WhatsApp |
|
|
|
|
### Despliegue
|
|
|
|
| Tema | Documento | Seccion |
|
|
|------|-----------|---------|
|
|
| Docker Compose | GUIA-DESPLIEGUE.md | Docker |
|
|
| Nginx | GUIA-DESPLIEGUE.md | Nginx |
|
|
| SSL/Certificados | GUIA-DESPLIEGUE.md | SSL |
|
|
| Variables entorno | ARQUITECTURA-MULTI-TENANT.md | Variables |
|
|
|
|
---
|
|
|
|
## Fuentes Canonicas
|
|
|
|
Para evitar duplicacion, estos son los documentos UNICOS para cada tema:
|
|
|
|
| Tema | Fuente Canonica | NO buscar en |
|
|
|------|-----------------|--------------|
|
|
| Schema BD | 02-especificaciones/ARQUITECTURA-DATABASE.md | Otros docs |
|
|
| Integraciones | 02-especificaciones/INTEGRACIONES-EXTERNAS.md | Epicas individuales |
|
|
| Multi-tenant | 90-transversal/ARQUITECTURA-MULTI-TENANT.md | Otros docs |
|
|
| Despliegue | 90-transversal/GUIA-DESPLIEGUE.md | Otros docs |
|
|
| Epicas | 01-epicas/*.md | Otros docs |
|
|
|
|
---
|
|
|
|
## Inventarios (YAML)
|
|
|
|
Para datos estructurados, consultar los inventarios:
|
|
|
|
| Inventario | Ubicacion | Contenido |
|
|
|------------|-----------|-----------|
|
|
| MASTER_INVENTORY.yml | orchestration/inventarios/ | Resumen consolidado |
|
|
| DATABASE_INVENTORY.yml | orchestration/inventarios/ | Schemas, tablas, indices |
|
|
| BACKEND_INVENTORY.yml | orchestration/inventarios/ | Modulos, endpoints |
|
|
| FRONTEND_INVENTORY.yml | orchestration/inventarios/ | Paginas, componentes |
|
|
|
|
---
|
|
|
|
## Actualizaciones
|
|
|
|
| Fecha | Cambio |
|
|
|-------|--------|
|
|
| 2026-01-10 | Creacion inicial del indice |
|
|
| 2026-01-10 | Consolidacion de ARQUITECTURA-DATABASE |
|
|
|
|
---
|
|
|
|
## Referencias Externas
|
|
|
|
- [PostgreSQL 15 Docs](https://www.postgresql.org/docs/15/)
|
|
- [NestJS Docs](https://docs.nestjs.com/)
|
|
- [React 19 Docs](https://react.dev/)
|
|
- [Stripe API](https://stripe.com/docs/api)
|
|
- [WhatsApp Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api)
|
|
|
|
---
|
|
|
|
**Ultima actualizacion:** 2026-01-10
|