A websocket based app for conducting a quick sprint retro.

https://demo.quickretro.app

https://quickretro.app

https://quickretro.app/guide/getting-started

The recommended way to install QuickRetro is by using Docker.

Ensure you have Docker Desktop OR Docker Engine with Compose plugin ready, and choose any of the below installation choices.

This creates containers for the app (with the latest vijeesh82/quickretro-app:latest image from DockerHub), and redis, using the compose.install.yml file.

# Download compose file to local directory
curl -LO https://raw.githubusercontent.com/vijeeshr/quickretro/main/compose.install.yml

# Run in detached mode in background
docker compose -f compose.install.yml up -d

# Download compose file to local directory
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/vijeeshr/quickretro/main/compose.install.yml" -OutFile "compose.install.yml"

# Run in detached mode in background
docker compose -f compose.install.yml up -d

Visit http://localhost:8921 to open the app.

To install by building from source, refer the installation docs

Ensure Go, Nodejs and Docker are installed.

cd ./src/frontend/

Install packages and dependencies.

npm install

Build the frontend.
This creates assets in "frontend/dist" directory. This dist directory is embedded in the backend Golang binary.

npm run build-dev

Navigate back to root directory.

docker compose up

Visit http://localhost:8921 (for older versions, use http://localhost:8080) to open the Vue app and start creating a board.

Run the app.

npm run dev

Visit http://localhost:5173/ to open.

• No Signups or Logins - That's right! No need to signup or login.
• No Board Limits - Create Boards or Invite Users without limits.
• Mobile Friendly UI - Easily participate from your mobile phone.
• Customize Column Names - Choose upto 5 columns with any name.
• Mask/Blur messages - Avoid revealing messages of other participants.
• Anonymous Messages - Post messages without revealing your name.
• Download as PDF - Download messages as PDF.
• Countdown Timer - Stopwatch with max 1 hour limit.
• Board Lock - Lock to stop addition/updation of messages.
• Dark Theme - Easily switch to use a Dark theme.
• Online Presence Display - See participants present in the meeting in realtime.
• Auto-Delete data - Auto-delete with configurable retention duration.