From 732a5b5a1660742f3fd435b75eed48a352342870 Mon Sep 17 00:00:00 2001 From: Josep Date: Sat, 3 Oct 2026 13:40:12 +0200 Subject: [PATCH] Initial commit --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1a7f837 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# TaskStream + +Alternativa a Jira para equipos de desarrollo: proyectos, tickets (bugs, features, cambios de UI, tareas y QA), +releases, comentarios y relaciones entre tickets, **en tiempo real**. + +- **API**: NestJS + GraphQL, arquitectura hexagonal, CQRS y event sourcing (escritura en PostgreSQL, lectura en MongoDB, + Redis entre ambas). +- **Web**: Angular 22 + NgRx Signals (patrón de eventos) + `@pi/ui`, con la misma arquitectura. +- **Usuarios**: los gestiona [Pireon](https://oauth.pireon.dev/api/documentation). + +## Empezar + +```sh +docker compose up -d --build # web en http://localhost:8080 +``` + +Para entrar hace falta un cliente OAuth de Pireon en `.env` (`PIREON_CLIENT_ID` y `PIREON_CLIENT_SECRET`, ver +[Autenticación](docs/05-autenticacion.md#registrar-taskstream-como-cliente-en-pireon)). Para desarrollar: + +```sh +npm install # @pi/ui necesita el token del Nexus de Pireon en ~/.npmrc +docker compose up -d postgres mongo redis +cp .env.example .env +npx nx serve api # http://localhost:3000/graphql +npx nx serve web # http://localhost:4200 +``` + +## Documentación + +| | | +| ------------------------------------------- | -------------------------------------------------------------------- | +| [Visión general](docs/01-vision-general.md) | Funcionalidades, stack y estructura del monorepo | +| [Arquitectura](docs/02-arquitectura.md) | Capas, CQRS, event sourcing, flujo escritura → lectura y tiempo real | +| [API](docs/03-api.md) | Dominio, workflow de tickets, eventos y operaciones GraphQL | +| [Cliente web](docs/04-cliente-web.md) | Stores con eventos, GraphQL y `@pi/ui` | +| [Autenticación](docs/05-autenticacion.md) | Tokens de Pireon, login en el navegador y webhooks | +| [Desarrollo](docs/06-desarrollo.md) | Comandos, tests, cómo añadir una funcionalidad y problemas conocidos | +| [Despliegue](docs/07-despliegue.md) | Docker, variables de entorno y escalado | +| [Decisiones](docs/08-decisiones.md) | Por qué está hecho así | + +Cada librería de `libs/api/*` y `libs/web/*` tiene su propio `README.md`. + +## Estructura + +``` +apps/api apps/web +libs/api/{shared,identity,tracker}/{domain,application,infrastructure,presenters} +libs/web/{shared,identity,tracker}/{domain,application,infrastructure,presenters} (+ web/shared/ui) +docs/ +``` + +```sh +npx nx run-many -t lint test build # todo +npx nx e2e api # flujo completo contra Docker +npx nx graph # dependencias entre proyectos +```