scrumlr.io

(★ 345)

Webapp for collaborative online retrospectives

File Explorer

Download Latest Version (.zip)

- - bug_report.yml
  - config.yml
- - clean_packages.yml
  - cleanup.yml
  - continuous-integration.yml
  - deploy_docs.yml
  - deploy_to_dev_cluster.yml
  - package.yml
  - rebuild_images.yaml
  - release.yml
- dependabot.yml
- pull_request_template.md
- release.yml
- .gitignore
- pre-commit
- - login-spec.cy.ts
  - templates-spec.cy.ts
- - commands.ts
  - e2e.ts
  - index.d.ts
- .gitignore
- tsconfig.json
- - .env.example
  - Caddyfile
  - dex.yaml
  - docker-compose.yml
- - README.md
- - .gitignore
  - cluster_issuer.yaml
  - create_db_job.yaml
  - deploy.sh
  - scrumlr_backend.yaml
  - scrumlr_frontend.yaml
- - favicon.svg
- - content.config.ts
  - env.d.ts
- .gitignore
- .yarnrc.yml
- astro.config.mjs
- package.json
- README.md
- tsconfig.json
- yarn.lock
- deployment.yaml
- - de.json
  - en.json
  - fr.json
- - board.png
  - config.png
  - signup.png
  - templates.png
- favicon.ico
- favicon.svg
- hotkeys.pdf
- robots.txt
- scrumlr-logo-light.svg
- timer_finished.mp3
- .gitignore
- convertFigmaIconExportToReact.mjs
- generateEmojiData.mjs
- - architecture.png
  - architecture.puml
  - todo.md
- - board_workflow_test.go
  - client.go
  - config.go
  - config.yaml
  - go.mod
  - go.sum
  - test_helpers.go
  - tls.go
- - setup-git-hooks.sh
- - .mockery.yaml
  - auth_provider_configuration_test.go
  - Dockerfile
  - go.mod
  - go.sum
  - main.go
- api.postman_collection.json
- config_example.toml
- docker-compose.dev.yml
- docker-compose.yml
- Makefile
- README.md
- - emoji-picker-element.ts
- - locales.test.ts
- - auth.ts
  - board.ts
  - boardReaction.ts
  - column.ts
  - feedback.ts
  - index.ts
  - info.ts
  - note.ts
  - participant.ts
  - reaction.ts
  - request.ts
  - templateColumns.ts
  - templates.ts
  - user.ts
  - vote.ts
  - votings.ts
- - scrumlr-logo-dark.png
  - scrumlr-logo-dark.svg
  - scrumlr-logo-light.svg
  - scrumlr-logo-mobile-dark.svg
  - scrumlr-logo-mobile-light.svg
- - _colors.scss
  - _mixins.scss
  - _styles.scss
  - avatar.ts
  - colors.ts
  - emojis.json
  - hotkeys.ts
  - i18n.ts
  - misc.ts
  - nameList.ts
  - recommendedTemplates.json
  - settings.ts
  - storage.ts
  - templates.json
  - templates.ts
- - index.ts
  - url.ts
- - RequireAuthentication.tsx
  - RouteChangeObserver.tsx
  - Router.tsx
- - index.ts
  - retryable.ts
  - store.md
  - store.ts
- - avatar.ts
  - emoji-picker.d.ts
  - i18next.d.ts
  - websocket.ts
- - auth.ts
  - boardReaction.ts
  - computedStyles.ts
  - datetime.ts
  - export.ts
  - hash.ts
  - i18n.ts
  - images.ts
  - participant.ts
  - random.ts
  - reactions.ts
  - redirect.ts
  - storage.ts
  - timer.ts
  - Toast.tsx
  - transitionConfig.ts
  - url.ts
- config.ts
- i18nTest.ts
- index.scss
- index.tsx
- service-worker.js
- setupTests.ts
- testUtils.tsx
.dockerignore
.editorconfig
.env
.env.development
.gitignore
.prettierrc
.stylelintrc.json
.yarnrc.yml
board.png
CODE_OF_CONDUCT.md
CONTRIBUTING.md
cypress.config.ts
Dockerfile
eslint.config.mjs
index.html
inovex.svg
LICENSE
nginx.conf
package.json
README.md
scrumlr.png
sonar-project.properties
tsconfig.json
vite-env-override.d.ts
vite-env.d.ts
vite.config.ts
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/inovex/scrumlr.io

Downloads the entire project code from GitHub to your computer.

cd scrumlr.io

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose -f deployment/docker/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

cd server/e2e-tests

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

5. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

cd deployment/helm/scrumlr

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

scrumlr.io

File Explorer

# Installation Guide

2. Docker

3. Node.js

4. Go

5. Make

Today's picks

Was this content helpful?

Recent Feedback

scrumlr.io

File Explorer

# Installation Guide

2. Docker

3. Node.js

4. Go

5. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README