michangarrito/README.md
rckrdmrd 97f407c661 [MIGRATION-V2] feat: Migrar michangarrito a estructura v2
- Prefijo v2: MCH
- TRACEABILITY-MASTER.yml creado
- Listo para integracion como submodulo

Workspace: v2.0.0 | SIMCO: v4.0.0
2026-01-10 11:28:54 -06:00

120 lines
2.8 KiB
Markdown

# MiChangarrito - Plataforma POS Multi-tenant
**Version:** 0.1.0
**Estado:** Desarrollo
**Tipo:** STANDALONE (SaaS)
**Sistema:** SIMCO + NEXUS v3.4
---
## Descripcion
Plataforma de punto de venta (POS) para tiendas pequenas y medianas en Mexico. Sistema multi-tenant con soporte para multiples canales: app movil, web, WhatsApp y asistente IA.
### Funcionalidades Principales
- Punto de venta rapido y facil
- Gestion de productos e inventario
- Control de clientes y fiados
- Pedidos y ordenes
- Integracion WhatsApp Business
- Asistente IA para ventas
- Reportes y analytics
- Pagos: Stripe, MercadoPago, Clip, CoDi, SPEI
---
## Stack Tecnologico
| Capa | Tecnologia |
|------|------------|
| Backend | NestJS + TypeScript |
| Frontend Web | React + Vite |
| Mobile | React Native |
| Database | PostgreSQL 16+ con RLS (Multi-tenant) |
| Cache | Redis |
| AI/LLM | OpenRouter, OpenAI, Claude, Ollama |
| WhatsApp | Meta Business API |
| Payments | Stripe, MercadoPago, Clip |
---
## Estructura del Proyecto
```
michangarrito/
├── apps/
│ ├── backend/ # API NestJS
│ ├── frontend/ # Web React
│ ├── mobile/ # React Native
│ ├── web/ # Landing page
│ ├── mcp-server/ # Servidor MCP para LLM
│ └── whatsapp-service/ # Integracion WhatsApp
├── database/
│ ├── schemas/ # DDL
│ └── seeds/ # Datos iniciales
├── docs/
│ ├── 00-vision-general/
│ ├── 01-epicas/
│ ├── 02-especificaciones/
│ └── 90-transversal/
└── orchestration/
├── 00-guidelines/
├── inventarios/
├── environment/
└── trazas/
```
---
## Modulos Principales
1. **Auth** - Autenticacion y autorizacion
2. **Tenants** - Multi-tenancy
3. **Products** - Catalogo de productos
4. **Inventory** - Control de inventario
5. **Sales** - Punto de venta
6. **Customers** - Clientes y fiados
7. **Orders** - Pedidos
8. **Reports** - Reportes y analytics
9. **Subscriptions** - Planes y suscripciones
10. **Payments** - Integracion de pagos
---
## Inicio Rapido
```bash
# Backend
cd apps/backend && npm install && npm run start:dev
# Frontend
cd apps/frontend && npm install && npm run dev
# MCP Server
cd apps/mcp-server && npm install && npm run start
# WhatsApp Service
cd apps/whatsapp-service && npm install && npm run start
```
---
## Variables de Entorno
Ver `.env.example` para la configuracion requerida.
---
## Referencias
- Vision: `docs/00-vision-general/VISION-PROYECTO.md`
- Arquitectura: `docs/00-vision-general/ARQUITECTURA-TECNICA.md`
- Requerimientos: `docs/00-vision-general/REQUERIMIENTOS-FUNCIONALES.md`
- Contexto: `orchestration/00-guidelines/`
---
**Creado:** 2026-01-04
**Actualizado:** 2026-01-07