Installation

Prerequisites

  • Node.js >= 24
  • npm >= 10
  • Go 1.26, matching the current go.work directive
  • Docker Engine with the Compose plugin (Docker Desktop is one supported distribution)
  • Python >= 3.12, only when working on the documentation site

Frontend setup

git clone git@github.com:Ready2Trace/PackyTrace.git
cd PackyTrace
make web

The consumer development server runs at http://localhost:5173. Run make brand in another terminal for the brand dashboard at http://localhost:5174.

By default the app uses its HTTP scan adapter and calls the local gateway at http://localhost:8080. Start the stack before exercising product lookup:

In one terminal, start the stack without attaching:

make up-detached

In a second terminal, start the consumer app:

make web

For isolated frontend work, explicitly select the in-memory fixture adapter:

PUBLIC_SCAN_ADAPTER=memory make web

Both PUBLIC_SCAN_ADAPTER and PUBLIC_API_BASE_URL are baked in at build time. See client/web-app/.env.example and the current web-app guide.

Documentation setup

cd PackyTrace
make docs

The documentation development server runs at http://localhost:8000.

Both commands install their required dependencies when they are missing. Run make help for the complete command list.

Full platform

make up

This builds the service images, waits until every container reports healthy, and then follows their logs. Press Ctrl+C to stop following logs; the containers keep running until make down.