Build And Release

The current package is @plato/pc-printer.

Scripts

Script	Command	Purpose
`clean`	`node scripts/clean.js`	Removes build artifacts, output, logs, zip, and `dump.rdb`.
`build`	`esbuild src/index.ts src/scripts/*.ts --bundle --platform=node --target=node12 --outdir=dist`	Bundles runtime code.
`start`	`node dist/index.js`	Starts the built driver.
`pkg`	`pkg dist/index.js -t node12-win-x64 -o output/plato-printer.exe --config package.json`	Creates Windows executable.
`bundle`	version bump, build, Redis prep, pkg, zip	Produces `plato-printer.zip`.
`stress`	`node scripts/stress-test.js`	Runs mock-printer load test.

Build Locally

pnpm --filter @plato/pc-printer clean
pnpm --filter @plato/pc-printer build
pnpm --filter @plato/pc-printer start

Create Release Zip

pnpm --filter @plato/pc-printer bundle

The bundle script:

Increments src/version.ts.
Builds the driver into dist.
Prepares the configured Windows Redis binary.
Builds output/plato-printer.exe.
Copies config.json.
Copies Caddy assets.
Copies certificates.
Copies redis-binaries/<redis.version>.
Creates plato-printer.zip.

Release Contents

plato-printer.exe
config.json
assets/
  caddy/
  certs/
redis-binaries/

Versioning

src/version.ts contains:

export const BUILD_VERSION = 66;

The build version is returned by GET /health and printed in the startup banner. Do not edit this file manually; scripts/increment-version.js updates it during pnpm bundle.

Caddy Preparation

Caddy is pinned to 2.6.4. To download Caddy into assets/caddy before bundling:

pnpm --filter @plato/pc-printer exec node scripts/download-caddy.js

If assets/caddy/caddy.exe exists, runtime setup can copy it instead of downloading Caddy on the customer machine.

Redis Binary Preparation

scripts/prepare-redis-binaries.js reads config.json and downloads the configured Windows Redis release if missing. The expected path is:

redis-binaries/<version>/Redis-<version>-Windows-x64-msys2/redis-server.exe

Stress Test

The stress test starts mock TCP printers and sends many /print requests.

pnpm --filter @plato/pc-printer stress

Useful options:

node scripts/stress-test.js \
  --host http://127.0.0.1:8080 \
  --printers 5 \
  --jobs 100 \
  --base-port 9200 \
  --poll-ms 500 \
  --timeout-ms 60000

The test passes when all target queues drain.

Release Checklist

Confirm config.json is correct for the release.
Confirm Caddy assets exist if HTTPS should work offline.
Run pnpm --filter @plato/pc-printer clean.
Run pnpm --filter @plato/pc-printer bundle.
Run the executable from output/.
Check GET /health.
Run a real test print.
Verify plato-printer.zip contains the expected files.

Point Of Sale (POS)

Kitchen Display (KDS)

Device Setup

Drivers & Downloads

Build And Release

Build And Release

Scripts

Build Locally

Create Release Zip

Release Contents

Versioning

Caddy Preparation

Redis Binary Preparation

Stress Test

Release Checklist

​Build And Release

​Scripts

​Build Locally

​Create Release Zip

​Release Contents

​Versioning

​Caddy Preparation

​Redis Binary Preparation

​Stress Test

​Release Checklist

Build And Release

Scripts

Build Locally

Create Release Zip

Release Contents

Versioning

Caddy Preparation

Redis Binary Preparation

Stress Test

Release Checklist