ScrymeDeveloper Docs
Installation & SDK

Install and configure the stack

Scryme supports a monorepo-based development workflow, a TypeScript SDK, and Docker-based infrastructure so teams can run secure local demo environments and production-ready integrations.


Prerequisites

  • Node.js 22+ and pnpm 9+ or 10+
  • Docker and Docker Compose for the API, Redis, databases, and local infrastructure
  • Rust toolchain if you are building native POS or bakery desktop apps

Workspace bootstrap

# Install workspace dependencies

pnpm install

# Start local infrastructure

docker compose up -d

Create an integration app

# Scaffold a new Scryme-enabled app

pnpm create scryme-app my-store-integration

TypeScript / Node SDK

# Install the core SDK package

pnpm add @scryme/sdk

Recommended development flow

Local validation

Use the local Docker stack and demo data to verify API contracts before rolling out to a live tenant.

Production readiness

Keep API keys, secrets, and webhook verification in a hardened environment and rotate credentials on a schedule.