Skip to main content

​
Quick start

Run the gateway directly without cloning anything:
The gateway starts and listens on http://localhost:8787.
Use bunx as a drop-in replacement for npx if you have Bun installed. It resolves and runs packages faster.

​
Build from source

Clone the repository and build when you need to customise the gateway or pin a specific version.
1

Clone the repository

2

Install dependencies and build

npm run build runs rollup -c to produce optimised CommonJS bundles in the build/ directory.
3

Start the server

The server listens on port 8787 by default.

​
Development mode

For local development with live reload:
npm run dev:node uses tsx to run src/start-server.ts directly without a build step.

​
Production configuration

Place a conf.json file in the project root before starting the server. The gateway loads it at startup:
conf.json
For Redis-backed caching, set the REDIS_CONNECTION_STRING environment variable before starting the server:
See the configuration reference for all available fields and environment variables.

​
Available scripts