From fc51414d9fd1ab5a40e87d6b58851e859682421a Mon Sep 17 00:00:00 2001 From: Levi Planelles Date: Tue, 12 May 2026 10:10:18 +0200 Subject: [PATCH] README.me update --- README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 54 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ee8e640..8d0ddbd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). - ![Preview](image.png) ## Dashboard de Proyectos Dolibarr @@ -16,6 +14,8 @@ Aplicación web moderna para visualizar y gestionar proyectos de Dolibarr con un - 🔐 API segura (API key protegida en el backend) - ⚡ Skeletons loading para mejor UX - 📄 Página de detalle completa para cada proyecto +- 🔑 Login con credenciales de Dolibarr +- ✅ Estados: Borrador, Activo y Cerrado --- @@ -24,8 +24,8 @@ Aplicación web moderna para visualizar y gestionar proyectos de Dolibarr con un ### Requisitos previos - Node.js 18+ -- Dolibarr con API habilitada -- Docker (opcional, para Dolibarr) +- Docker (para Dolibarr + MariaDB) +- Dolibarr con API REST habilitada ### Instalación @@ -40,7 +40,24 @@ cd trello_fake npm install ``` -3. **Configurar variables de entorno** +3. **Levantar Dolibarr con Docker** +```bash +docker-compose up -d +``` + +Abre Dolibarr en `http://localhost:8200` y completa el asistente inicial si es la primera vez. + +Credenciales de instalación: +- **Admin:** admin / p4ssw0rd +- **DB:** host=mariadb, db=dolibarr, user=dolibarr, pass=dolibarr_password + +4. **Habilitar API REST y generar API Key** + +En Dolibarr: +- Configuración > Módulos/Aplicaciones > **API REST** +- Configuración > API REST > Generar API Key + +5. **Configurar variables de entorno** Crea un archivo `.env.local` en la raíz: @@ -51,14 +68,19 @@ DOLIBARR_API_KEY=tu-api-key-aqui # Variables públicas NEXT_PUBLIC_DOLIBARR_USER_ID=2 + +# Compatibilidad (deprecated) +NEXT_PUBLIC_API_URL=http://localhost:8200/api/index.php +NEXT_PUBLIC_DOLIBARR_API_KEY=tu-api-key-aqui ``` -4. **Iniciar el servidor de desarrollo** +6. **Iniciar el servidor de desarrollo** ```bash npm run dev ``` Abre [http://localhost:3000](http://localhost:3000) en tu navegador. +Inicia sesión con tus credenciales de Dolibarr. --- @@ -71,11 +93,10 @@ Si no tienes proyectos en tu Dolibarr, puedes generar datos de prueba: npm run seed ``` -Este comando creará 12 proyectos de ejemplo con: -- Diferentes estados de progreso (0% - 100%) -- Presupuestos variados (€28k - €120k) -- Descripciones detalladas -- Fechas realistas +Este comando elimina los proyectos existentes y crea **14 proyectos** con tareas: +- Estados: **Borrador**, **Activo** y **Cerrado** +- Progreso y presupuestos variados +- Tareas asociadas por proyecto Ver más detalles en [scripts/README.md](scripts/README.md) @@ -98,13 +119,24 @@ Ver más detalles en [scripts/README.md](scripts/README.md) ├── lib/ # Utilidades y servicios │ ├── dolibarrClient.ts # Cliente de API │ ├── projectsService.ts # Servicio de proyectos -│ └── usersService.ts # Servicio de usuarios +│ ├── tasksService.ts # Servicio de tareas +│ ├── usersService.ts # Servicio de usuarios +│ └── authService.ts # Login y verificación de token ├── types/ # Definiciones TypeScript └── scripts/ # Scripts de utilidad ``` --- +## 🧠 Arquitectura (resumen) + +- **UI (Next.js):** muestra proyectos y tareas. +- **Proxy API (`/api/dolibarr/...`):** protege la API key y reenvía llamadas a Dolibarr. +- **Dolibarr + MariaDB:** fuente real de datos. +- **Auth:** login contra Dolibarr, token guardado en localStorage y cookie para el middleware. + +--- + ## 🛠️ Scripts Disponibles ```bash @@ -112,7 +144,7 @@ npm run dev # Servidor de desarrollo npm run build # Build de producción npm run start # Servidor de producción npm run lint # Ejecutar ESLint -npm run seed # Crear proyectos de prueba +npm run seed # Reset + crear proyectos y tareas de prueba ``` --- @@ -140,9 +172,18 @@ La aplicación implementa las siguientes medidas de seguridad: --- +## ✅ Estados de Proyecto + +- **0 - Borrador** +- **1 - Activo** +- **2 - Cerrado** + +--- + ## 📖 Documentación Adicional - [AGENTS.md](AGENTS.md) - Guías para agentes de IA y arquitectura del proyecto +- [QUICK_START.md](QUICK_START.md) - Guía rápida para levantar y usar el proyecto - [scripts/README.md](scripts/README.md) - Documentación de scripts de utilidad ---