niradler/scadflow repository overview

⁠ScadFlow

Design printable 3D models in your browser — start from templates, preview instantly, leave notes on the model, and keep full control of every change.

ScadFlow helps you create and refine 3D-printable models without fighting complex tools.

Open it in your browser and:

• Start from ready-made starters (keycaps, enclosures, trays, and more)
• See a live 3D preview as you work
• Pin notes right on the model so feedback stays with the design
• Ask an AI assistant for ideas — nothing changes until you approve it
• Save versions and download files ready for your printer

Built for beginners who want clear steps, and for makers who want a careful review loop before anything is final.

Runs on your own computer. Your designs stay with you.

Image: niradler/scadflow:0.0.1
Open in browser: http://127.0.0.1:3000⁠

⁠What you need

• Docker Desktop⁠ (Windows or Mac) or Docker Engine with Compose on Linux
• About 4 GB of memory available to Docker
• Docker Desktop must be running before you start

⁠Install

1. Download the public install bundle (Compose file + setup scripts):
   https://gist.github.com/niradler/580fd522295f47d2d1780d74fd2ef83c⁠
   Use Download ZIP, or clone the gist, then open that folder in a terminal.
2. Create your private passwords and data folders:

# macOS / Linux
sh setup-docker.sh

# Windows PowerShell
.\setup-docker.ps1

1. Start ScadFlow:

docker compose up --detach

1. Open http://127.0.0.1:3000⁠

The first start downloads the image and can take a few minutes. Check that it is ready with:

docker compose ps

When scadflow shows as healthy, you are ready.

⁠Everyday use

From the same install folder:

docker compose ps
docker compose logs --follow scadflow
docker compose restart scadflow
docker compose down

docker compose down stops ScadFlow but keeps your saved designs on disk.

⁠Update without losing designs

Your designs live under ~/.scadflow, not inside the install folder. To update:

1. Download a fresh copy of the install bundle⁠.
2. Copy your existing .env.docker and .env.docker.postgres into the new folder (do not re-run setup unless you intend to start over).
3. Start again:

docker compose pull
docker compose up --detach

Optional: use another local port for one run:

SCADFLOW_PORT=8080 docker compose up --detach

⁠Where your files live

On Windows that is usually %USERPROFILE%\.scadflow\.

Passwords stay next to compose.yaml in .env.docker and .env.docker.postgres. Do not share or commit those files.

If you later move off Docker to a local install, you can point that install at the same workspace (and review data) folders manually — your project files are already there.

⁠Install bundle files

The public gist⁠ includes: