@@ -74,24 +100,26 @@ Clona este repositorio:
git clone https://github.com/Rumazor/task-manager
cd task-manager
-Crea tu archivo `.env` en la raíz, con los valores adecuados (ver sección anterior).
-
-Construye los contenedores:
+Crea tu archivo `.env` en la raíz:
- docker-compose build
+ cp .env.example .env
-Inicia los servicios:
+Construye e inicia los contenedores:
- docker-compose up
+ docker compose up -d
-- El **backend** arrancará en `localhost:3001`.
-- El **frontend** se expondrá en `localhost:3000`.
+### URLs disponibles
-Abre tu navegador en `http://localhost:3000` para ver la interfaz de Next.js.
+| Servicio | URL |
+|----------|-----|
+| Frontend | http://localhost:3000 |
+| Backend API | http://localhost:3001 |
+| Swagger Docs | http://localhost:3001/docs |
+| Portainer | http://localhost:9000 |
-El backend (NestJS) responderá en `http://localhost:3001`.
+---
-### Poblar la base de datos con datos de prueba
+## Poblar la base de datos con datos de prueba
Para iniciar con datos de prueba, ejecuta el script de seed:
@@ -99,7 +127,7 @@ Para iniciar con datos de prueba, ejecuta el script de seed:
O manualmente:
- docker compose exec nestjs yarn seed
+ docker compose exec nestjs npm run seed
**Cuentas de prueba creadas:**
@@ -117,31 +145,36 @@ O manualmente:
- 5 etiquetas
- 17 tareas (incluyendo subtareas y asignaciones)
-## Rutas principales (Backend)
+---
-- `POST /auth/login`
- Inicia sesión y devuelve un JWT (además de configurar la cookie).
+## Rutas principales (Backend)
-- `POST /auth/register`
- Crea un usuario nuevo.
+- `POST /auth/login` - Inicia sesión y devuelve un JWT.
+- `POST /auth/register` - Crea un usuario nuevo.
+- `GET /tasks` - Lista las tareas (requiere autenticación).
+- `POST /tasks` - Crea una tarea (requiere autenticación).
+- `PATCH /tasks/:id` - Actualiza una tarea específica.
+- `DELETE /tasks/:id` - Elimina la tarea.
+- `GET /health` - Health check del servidor.
-- `GET /tasks`
- Lista las tareas (requiere estar autenticado).
+**Swagger:** La documentación completa está disponible en `/docs`.
-- `POST /tasks`
- Crea una tarea (requiere estar autenticado).
+---
-- `PATCH /tasks/:id`
- Actualiza una tarea específica.
+## Monitoreo con Portainer
-- `DELETE /tasks/:id`
- Elimina la tarea.
+
+ 
+
-Asegúrate de pasar el JWT (o la cookie) con cada request si la ruta está protegida.
+Portainer está incluido para monitorear los contenedores:
-Doc Swagger: La documentación generada con Swagger está disponible en la ruta /docs (asumiendo que el backend corre localmente en el puerto 3001).
+1. Abre http://localhost:9000
+2. Crea un usuario admin (primera vez)
+3. Selecciona "local" environment
+4. Ve a "Containers" para ver logs y stats
-- **Nota**: Este proyecto incluye un archivo `insomnia_task_manager.json` que puedes importar en Insomnia para probar los endpoints descritos arriba. El archivo configura las rutas con ejemplos de cuerpos de solicitud y autenticación con JWT.
+---
## Flujo de autenticación en el Frontend
@@ -159,117 +192,63 @@ Doc Swagger: La documentación generada con Swagger está disponible en la ruta
- Antes de acceder a la ruta protegida (`/dashboard`) se verifica la cookie y JWT.
- Si no estás autenticado, redirige a `/`.
-## Scripts útiles
-
-Si deseas ejecutar el **backend** sin Docker:
-
- cd backend
- yarn install
- yarn start:dev
- En el.env DB_HOST colocar **localhost**
-
-Si quieres ejecutar el **frontend** sin Docker:
-
- cd frontend
- yarn install
- yarn dev
- En el .env BASE_API_URL colocar **"http://localhost:3000"**
-
-En este caso, asegúrate de configurar tu `.env` en Next.js y NestJS para apuntar a la base de datos adecuada y que Next.js consuma la URL correcta del backend.
+---
-## Base de datos
+## Scripts útiles
-
+
- 
-
+```bash
+# Ver logs en tiempo real
+docker compose logs -f nestjs
-### El backend requiere PostgreSQL.
+# Reiniciar un servicio
+docker compose restart nestjs
-Tienes dos opciones:
+# Reconstruir un servicio
+docker compose build nestjs && docker compose up -d nestjs
-- Opción 1:
+# Ejecutar tests
+docker compose run --rm nestjs-test npm test
- Usar Docker solo para PostgreSQL:
+# Detener todo
+docker compose down
- cd backend
- docker-compose up
+# Detener y eliminar volúmenes
+docker compose down -v
+```
- Asegúrate de descomentar la sección del servicio de PostgreSQL en el archivo docker-compose.yml del backend:
+Si deseas ejecutar el **backend** sin Docker:
- services:
- db:
- image: postgres:14.3
- restart: always
- ports: - '${DB_PORT}:${DB_PORT}'
- environment:
- POSTGRES_PASSWORD: ${DB_PASSWORD}
- POSTGRES_DB: ${DB_NAME}
- volumes: - ./posgres:/var/lib/postgresql/data
+ cd backend
+ npm install
+ npm run start:dev
+ # En el .env usar DB_HOST=localhost
- Esto iniciará solo el contenedor de PostgreSQL definido en el archivo docker-compose.yml que se encuentra en la carpeta /backend.
+Si quieres ejecutar el **frontend** sin Docker:
-- Opción 2:
+ cd frontend
+ npm install
+ npm run dev
+ # En el .env usar BASE_API_URL="http://localhost:3001"
- Usar PostgreSQL instalado localmente o cualquier otra instalación de PostgreSQL a la que tengas acceso. Asegúrate de actualizar las credenciales en tu archivo .env según corresponda.
+---
## CI/CD con GitHub Actions
-
- 
+
-Este proyecto implementa un pipeline de integración continua mediante GitHub Actions que se ejecuta automáticamente en cada push a la rama principal
-
-Para automatizar la ejecución de tests (CI) cada vez que hagas un push, puedes usar este flujo básico de GitHub Actions. Solo necesitas:
-
-- Crear la carpeta .github/workflows/ en la raíz del proyecto.
-- Dentro de ella, un archivo ci.yml (por ejemplo) con este contenido:
+El pipeline se ejecuta automáticamente:
- name: CI Pipeline
+- **En Pull Requests:** Ejecuta tests
+- **En merge a main:** Tests + Build + Push a DockerHub
- on:
- push:
- branches: [ "main" ]
- pull_request:
+El Dockerfile usa multi-stage builds optimizados:
+- Imagen base `node:20-alpine` (ligera)
+- Stage `test` para CI con devDependencies
+- Stage `production` solo con dependencias de producción
- jobs:
- build-and-test:
- runs-on: ubuntu-latest
-
- steps: - name: Check out the repository
- uses: actions/checkout@v3
-
- - name: Set up Docker Buildx
- uses: docker/setup-buildx-action@v2
-
- - name: Build containers
- run: docker compose -f docker-compose.yml build
-
- - name: Start only the database (Postgres) in background
- run: docker compose -f docker-compose.yml up -d postgres
-
- - name: Wait for Postgres to be ready
- run: |
- echo "Esperando a que Postgres inicie..."
- until nc -z localhost 5432; do
- echo "Postgres no está listo aún..."
- sleep 1
- done
- echo "¡Postgres está listo!"
-
- - name: Run NestJS tests
- run: docker compose -f docker-compose.yml run --rm nestjs yarn test
-
- - name: Cleanup
- if: always()
- run: docker compose -f docker-compose.yml down -v
-
-El pipeline incluye:
-
-- Construcción de contenedores Docker
-- Inicialización de la base de datos PostgreSQL
-- Ejecución de tests automatizados
-- Limpieza de recursos al finalizar
+---
## Personalización de UI (Tailwind & shadcn/ui)
@@ -278,9 +257,11 @@ El pipeline incluye:
+
-
-
-