Guide
Installation
Set up the Azmara Platform monorepo locally.
Prerequisites
- Node.js >= 20.0.0
- pnpm >= 9.0.0
- For
@azmr/ai: Visual Studio 2022 with "Desktop development with C++" workload
Clone & install
git clone https://github.com/azmara-labs/platform.git
cd platform
pnpm installEnvironment setup
cp .env.example .envFill in the required values:
# Generate an encryption key
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"Build all packages
pnpm buildTry the playground
pnpm --filter @azmr/docs devThen open /playground — a live, interactive demo of @azmr/core, @azmr/query, and @azmr/ui
working together, no separate app to run. See the Playground guide for
what it demonstrates.
Native module note
@azmr/ai uses isolated-vm which requires native compilation.
Windows:
- Install Visual Studio 2022 with "Desktop development with C++" workload
- Run
pnpm rebuild isolated-vm
macOS: Xcode Command Line Tools (xcode-select --install)
Linux: sudo apt install build-essential python3