retro.tools

(โ˜… 102)

Free team retrospective tool

  • .dockerignore
  • .env.development
  • .env.production
  • .firebaserc
  • .gitignore
  • .prettierrc
  • CLAUDE.md
  • CONTRIBUTING.md
  • cypress.config.js
  • Dockerfile
  • eslint.config.js
  • firebase.json
  • index.html
  • jsconfig.json
  • LICENSE
  • package-lock.json
  • package.json
  • README.md
  • svelte.config.js
  • vite.config.js

# Installation Guide

1. Get the code
git clone https://github.com/d0x2f/retro.tools

Downloads the entire project code from GitHub to your computer.

cd retro.tools

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 build -t retro-tools .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 retro-tools

Runs the built image as an actual container.

โœ… 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.
// repository documentation