How juangatti/stockmanagerapp works
Project type and purpose
• Este proyecto es una aplicación web full-stack para la gestión de inventario (“MauerApp – Gestor de Stock”), compuesta por un backend RESTful en Node/Express y un frontend en React (Vite).
• Su objetivo principal es ofrecer funcionalidades de CRUD para catálogo, registro de compras, procesamiento de ventas via Excel, ajustes de stock y visualización de historiales, con autenticación JWT y roles diferenciados.
Analizar la estructura de archivos
• Top-level:
• Backend/ → servidor, rutas, controladores, middleware, configuración de BD.
• Frontend/ → aplicación React organizada con Vite, Atomic Design (atoms, molecules, organisms), hooks, layouts, páginas, stores.
• README.md + .gitignore
• Backend sigue patrón MVC:
• server.js arranca Express + CORS + Rutas + Middleware global.
• config/db.js gestiona pool de conexión a MySQL.
• routes/ define endpoints agrupados por recurso (auth, admin, stock, sales, prebatch).
• controllers/ contienen la lógica de cada ruta.
• middleware/authMiddleware.js valida JWT y roles.
• Dependencias clave: mysql2/promise, jsonwebtoken, bcryptjs, multer+xlsx.
• Frontend usa React + Zustand para estado global + React Router para navegación.
• src/api/api.js abstrae llamadas Axios al backend.
• Atomic Design: atoms (botones, alertas), molecules (formularios pequeños, modals, sidebars), organisms (tablas, manager UIs), pages (rutas principales).
• Layouts definen protecciones (AdminRoute) y contorno (MainLayout).
• Stores con Zustand: useAuthStore, useStockStore.
Insights del README
• Tech Stack confirmado; flujo auth con JWT, cierre por inactividad, roles “admin” vs “operator”.
• Componente de subida de .xlsx para procesar ventas.
• Frontend consume API base vía VITE_API_BASE_URL.
• No hay colas ni microservicios; todo corre en un único proceso de Node y una única SPA de React.
a. Componentes principales:
• Cliente Web (React SPA)
• API Server (Node.js + Express)
• Base de Datos MySQL
• Servicio de Autenticación (JWT dentro del API)
• Procesador de Excel (Multer + XLSX dentro del API)
b. Relaciones e interacciones:
• Usuario → HTTP(S) → React Router → Componentes de UI → llamadas Axios
• Axios → API Server routes → authMiddleware (JWT) → controllers → config/db → MySQL
• Subida de .xlsx → Multer middleware → controller.salesController → lógica de receta → DB
c. Patrones y principios:
• Backend: MVC + Middleware para separación de responsabilidades (auth, rutas, lógica de negocio).
• Frontend: Atomic Design + State Management (Zustand).
• Single Page Application (SPA) separada del API (cliente-servidor estricto).
d. Tecnologías clave a anotar:
• Express.js, mysql2/promise, jsonwebtoken, bcryptjs, multer, xlsx
• React, Vite, React Router, Zustand, Tailwind CSS, Axios
Guías para este full-stack app
• Mostrar dos zonas bien diferenciadas: Frontend y Backend.
• En Frontend, agrupar: Router + Layouts → Pages → Organisms/Molecules/Atoms. Indicar el store de Zustand.
• En Backend, separar: server.js + middleware (CORS, auth), routers, controllers, config/db.
• Dibujar la Base de Datos como un componente externo con flechas de “read/write” desde controllers.
• Mostrar la parte de procesamiento de Excel como un sub-módulo de ventas dentro del API.
Elementos a incluir en el diagrama
• Etiquetas claras (por ejemplo: “AuthController”, “useAuthStore”, “InventoryTable Component”).
• Flechas direccionadas para flujo de datos y dependencias (HTTP calls, DB queries, middleware chain).
• Formas o colores distintos:
• Rectángulos azules para componentes frontend,
• Rectángulos verdes para capas backend (routers, controllers),
• Cilindro para la BD MySQL,
• Hexágono para servicios externos (JWT, Multer/XLSX).
Detalle y granularidad
• No hace falta desglosar cada uno de los 30 atomos de UI, pero sí destacar patrones: la folder structure atomic, el store global, el entrypoint App.jsx.
• En backend, es útil mostrar al menos un flujo completo: Login → authMiddleware → authController → DB, y otro: Upload .xlsx → salesController → Business Logic → DB.
• Evita simplificar demasiado; captura carpetas y responsabilidades clave.