Skip to main content

Installation

Requirements​

  • Node.js 22 or newer
  • A server-side TypeScript or JavaScript project with ESM support
  • A Discord OAuth application
  • HTTPS in production
npm install @kavtuai/guildgate@1.1.1

Fastify, Express, Hono, PostgreSQL, Redis, discord.js, and OpenTelemetry remain application choices:

npm install pg redis fastify hono discord.js ws @opentelemetry/api

Published import paths​

Alongside the root package, these subpaths are published:

discord · fastify · express · redis · realtime · testing
analytics · contracts · discordjs · hono · operator · postgres
telemetry · transactions · locks

Example:

import {createGuildGate} from "@kavtuai/guildgate";
import {createPostgresAdapter} from "@kavtuai/guildgate/postgres";
import {attachSocketIo} from "@kavtuai/guildgate/realtime";

Do not import internal src/ or dist/ files. Semver applies to the root package and 15 public subpaths.

CLI check​

npx guildgate-doctor --help
npx guildgate-writing-check --help
npx guildgate-migration --help

Verify the version​

node -p "require('./node_modules/@kavtuai/guildgate/package.json').version"

The expected value is 1.1.1. Continue with Start in five minutes.

Last updated on