husseinakar/playthrough repository overview

⁠Playthrough

Draw the feature before it exists. Then play your scenarios through the drawing.

A team designing a feature draws a flow on a whiteboard and lists the cases in a spreadsheet. The two never meet, so nobody notices the case that no branch handles until the code is written. Playthrough puts them on one page: you draw the flow as nodes joined by guarded edges, each scenario is a row of inputs and expectations, and every row is played through the drawing as you type, turning green or red.

⁠Try it

docker run --rm -p 8095:8095 husseinakar/playthrough

1. Open http://localhost:8095⁠.
2. Click Template → Presets, and press Load it on Simple.
3. Click the red row in the table, Phone order, to see its path, and double-click it to see why it fails.

Whatever you save this way lives inside the container and is gone when it stops.

⁠Keep your flows

Run it from the repository the feature belongs to, with a folder mounted:

docker run -d --name playthrough -p 8095:8095 \
  -v "$PWD/specs:/app/specs" \
  husseinakar/playthrough

On Linux, add --user "$(id -u):$(id -g)" so the container can write to the folder. Docker Desktop on macOS and Windows does not need it.

⁠Docker Compose

services:
  playthrough:
    image: husseinakar/playthrough
    ports:
      - "8095:8095"
    volumes:
      - ./specs:/app/specs
    restart: unless-stopped
    # On Linux, your own ids, from `id -u` and `id -g`:
    # user: "1000:1000"

⁠Reference

To update: docker pull husseinakar/playthrough, then remove the container and start it again. Your flows are in the mounted folder, not in the container.

There is no authentication. Run it on your machine or a trusted network.

⁠More

The full guide (drawing, conditions, scenarios, generating scenarios, keys, the file format and the HTTP API) is in the repository: https://github.com/hussein-akar/playthrough⁠.

Apache 2.0.