https://github.com/fedeegmz/open-retro
Tablero de retrospectivas colaborativo en tiempo real. Crea una sala, comparte el ID y trabajen juntos desde cualquier lugar.
https://github.com/fedeegmz/open-retro
bun elysiajs monorepo open-source retrospectives typescript vue
Last synced: 22 days ago
JSON representation
Tablero de retrospectivas colaborativo en tiempo real. Crea una sala, comparte el ID y trabajen juntos desde cualquier lugar.
- Host: GitHub
- URL: https://github.com/fedeegmz/open-retro
- Owner: fedeegmz
- License: mit
- Created: 2026-03-11T20:27:56.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-04-22T23:32:10.000Z (about 2 months ago)
- Last Synced: 2026-04-23T01:25:44.834Z (about 2 months ago)
- Topics: bun, elysiajs, monorepo, open-source, retrospectives, typescript, vue
- Language: Vue
- Homepage: https://openretro.app/
- Size: 918 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# open-retro
Herramienta de retrospectiva colaborativa en tiempo real. Permite a equipos crear tableros compartidos donde agregar notas y agruparlas durante sesiones de retrospectiva.
## Caracteristicas
- Tableros en tiempo real sincronizados via WebSocket
- Creacion y union a tableros con contrasena
- Agregar, editar y eliminar notas
- Agrupar notas en categorias
- Reconexion automatica ante desconexiones
## Estructura del proyecto
```
open-retro/
├── server/ # Servidor WebSocket (Bun + Elysia)
├── shared/ # Tipos compartidos
└── web-client/ # Frontend (Vue 3 + Vite)
```
## Docker
### Levantar con Docker Compose
```bash
docker compose up --build
```
- Servidor: `http://localhost:3001`
- Cliente: `http://localhost:5173`
Los cambios en `server/src/`, `web-client/src/` y `shared/` se reflejan automáticamente en los contenedores (hot reload).
### Variable de entorno `ENVIRONMENT`
Cada servicio acepta la variable `ENVIRONMENT` para controlar el modo de ejecución:
| Valor | Servidor | Cliente |
|---|---|---|
| `develop` (default) | `bun --watch src/server.ts` | `vite` dev server |
| `production` | `bun src/server.ts` | `vite build` + `vite preview` |
Para cambiar el modo, editar `docker-compose.yml`:
```yaml
environment:
ENVIRONMENT: "production"
```
### Configuración del Servidor
El servidor acepta las siguientes variables de entorno para su configuración:
| Variable | Descripción | Valor por defecto |
|---|---|---|
| `PORT` | Puerto en el que corre el servidor | `3001` |
| `CORS_ORIGINS` | Orígenes permitidos (separados por `;`) | `*` |
| `SESSION_TIME_LIMIT` | Tiempo máximo en segundos para una sesión (vencimiento) | Sin límite |
| `ADMIN_GRACE_SECONDS` | Tiempo de gracia en segundos tras el vencimiento antes de borrar datos | `60` |
| `MAX_USERS_PER_SESSION` | Límite de usuarios conectados por tablero | Sin límite |
Esto se puede configurar en el archivo `docker-compose.yml` bajo la sección `environment` del servicio `server`.
### Limpiar contenedores y volúmenes
```bash
docker compose down -v
```
---
## Desarrollo
### Configuracion inicial
Desde la raiz del proyecto, instalar dependencias e instalar los git hooks:
```bash
npm install
```
El script `prepare` se ejecuta automaticamente e instala el pre-commit hook via `simple-git-hooks`.
### Servidor
```bash
cd server
bun run dev # con hot reload
bun run start # sin watch
```
### Cliente web
```bash
cd web-client
npm run dev # servidor de desarrollo
npm run build # build de produccion
npm run lint # linter (oxlint + eslint)
```
### Calidad de codigo
Los scripts de formato y linting se ejecutan desde la raiz y cubren todos los packages:
```bash
npm run format # formatea server/, shared/ y web-client/src/
npm run lint # oxlint sobre todos los packages
npm run lint:eslint # eslint (Vue/TS) sobre web-client/
```
El pre-commit hook corre automaticamente sobre los archivos staged en cada commit:
1. `oxfmt` — formatea el archivo
2. `oxlint --fix` — corrige errores de linting
3. `eslint --fix` — corrige reglas Vue/TS (solo archivos en `web-client/src/`)
## Como funciona
1. El cliente se conecta al servidor ingresando la URL del servidor WebSocket.
2. Crea o se une a un tablero con una contrasena.
3. Todas las acciones (agregar/editar/eliminar notas y grupos) se sincronizan en tiempo real con todos los participantes del tablero.
4. Al conectarse, el servidor envia el estado completo del tablero. Los tableros se eliminan de memoria cuando el ultimo cliente se desconecta.
## Tecnologias
- **Servidor**: [Bun](https://bun.sh), [Elysia](https://elysiajs.com)
- **Cliente**: [Vue 3](https://vuejs.org), [Vite](https://vitejs.dev), TypeScript