Setup
Quick-start guide for running the Wenex platform.
In this section
- Prerequisites — Node.js, Docker, and Git requirements.
- Start Infrastructure — Launch the core infrastructure stack with Docker Compose.
- Manually Setup — Clone, install, initialize, and start the platform from source.
- Docker Setup — Run the full platform as Docker containers.
- Kubernetes Setup — Deploy using the official Helm chart.
- Configuration — Full environment variable and Helm values reference.
Prerequisites
Git is required to clone the repository and manage submodules. Any recent version works.
Docker and Docker Compose are required to run the infrastructure stack. Any recent version works.
Node.js 22.x and pnpm 10.5.2 are required for the platform itself. The repository includes an .nvmrc file pinning the exact Node version. Use nvm to install and activate it, then enable corepack so the correct pnpm version is available automatically:
bash
nvm install # installs the Node version from .nvmrc
nvm use # switches to it
corepack enable