docs: create main README.md

2026-07-08 14:15:29 -06:00
parent 52470a44cb
commit 6cfdf16959
1 changed files with 37 additions and 0 deletions
@@ -0,0 +1,37 @@
+# Hazard Odoo & Shopify Connector
+
+Este repositorio aloja la infraestructura, configuración y módulos personalizados (Addons) para el ERP Odoo 16 de **Hazard**, enfocado en la marca de ropa urbana. El núcleo de este proyecto es su integración bidireccional y reactiva con el eCommerce en **Shopify**.
+
+## 🚀 Arquitectura del Proyecto
+
+El sistema se ejecuta en un VPS mediante Docker Compose, incluyendo:
+* **Odoo 16** (`hazard-odoo-odoo`): Contenedor custom basado en Odoo Community, inyectado con módulos Enterprise.
+* **PostgreSQL 17** (`odoo-16-db-hazard-new`): Base de datos en el puerto interno `5432`.
+
+### Módulos Customizados (`/Addons/custom/`)
+* **`hazard_shopify`**: El conector principal de más de 4500 líneas. Maneja inventario reactivo (colas asíncronas), importación de pedidos B2C, fulfillment automatizado, traslados BOPIS (retiro en tienda), cálculos de reembolsos y gestión de catálogo (excluyendo estrictamente el flujo B2B y Maquila).
+* **`hazard_inventory_report`**: Módulo para emisión de reportes especializados.
+
+---
+
+## 🤖 Automatización y Agentes IA (MCP)
+
+Este repositorio está preparado para el futuro con **Model Context Protocol (MCP)**, permitiendo a los agentes de Inteligencia Artificial operar directamente sobre la lógica de negocio, bases de datos y APIs externas de manera segura:
+
+1. **`odoo-mcp-hazard/`**
+   Servidor MCP en Python (ejecutado vía `uv`) que conecta con la API XML-RPC de Odoo. 
+   *Herramientas:* `odoo_search_read`, `odoo_create`, `odoo_write`, `odoo_execute_method`.
+
+2. **`shopify-mcp/`**
+   Servidor MCP en Node.js que interactúa directamente con la API REST de la tienda Shopify para comprobación en tiempo real de transacciones, órdenes e inventario base.
+
+3. **PostgreSQL MCP**
+   Conexión de lectura SQL directa a la base de datos interna `hazard_new` para minería y auditoría rápida.
+
+---
+
+## 📜 Reglas del Proyecto y Desarrollo
+
+Toda la documentación técnica profunda, decisiones de arquitectura (como la lógica de nombrado de SKU, diccionarios de tallas/colores) y reglas estrictas para Inteligencias Artificiales se encuentran centralizadas en el archivo de personalización.
+
+👉 **Por favor consulta [`.agents/AGENTS.md`](.agents/AGENTS.md) antes de proponer o realizar cualquier cambio al código base.**