Josep Piguillem
341241a52f
A REST adapter next to GraphQL (presenters/http) that calls the same application services, so validation, permissions and domain errors are the same: projects (members, board, stats, activity), issues (search, workflow, assignee, release, links, comments, history), comments, releases and users. Projects and issues can be addressed by id or key (WEB, WEB-12). - Swagger UI at /api/docs, document at /api/docs-json and apps/api/openapi.json (rewritten by `nx serve api`, like schema.gql) for client generation. - Every route but health/auth/webhook needs a Pireon token: the document declares Pireon OAuth2 (authorization code + PKCE, password) through the /api/auth/token proxy, and a bearer scheme for apps with their own client. - configureApp() shares main.ts setup with the e2e, which now also covers REST. - SWAGGER_ENABLED / OPENAPI_FILE config; docs 03/05 and library READMEs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
57 lines
2.9 KiB
Markdown
57 lines
2.9 KiB
Markdown
# 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 y REST con OpenAPI (Swagger, para otras apps), 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 · REST: /api/docs
|
|
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, GraphQL y REST (OpenAPI) |
|
|
| [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
|
|
```
|