Skip to content
← Connectum

Your service, your choices

Start small.
Add what you need.

Choose a runtime and a few capabilities. Inspect the real scaffold, see each change, and take the project with you.

Configure your service

A new folder and package name. Lowercase, for example payments-api.

Runtime

Use a maintained Node.js release that meets this requirement.

Package manager For Node.js
Add capabilities 0 selected
Resilience Opt-in defaults

Fallback is intentionally not a checkbox: it needs your application-specific handler.

Already in the base

Greeter service, health checks, reflection, graceful shutdown and a validation interceptor. Add constraints in your proto →

See what changes

0 changed files

Your base service. Select options to see what changes.

src/server.ts
/** * Server factory — services, health, reflection, interceptors, graceful shutdown. * * @module server */ import { createServer } from "@connectum/core";import type { Server } from "@connectum/core";import { Healthcheck } from "@connectum/healthcheck";import { Reflection } from "@connectum/reflection";import { createDefaultInterceptors } from "@connectum/interceptors";import { greeterService } from "#services/greeterService.ts"; /** * Build a Connectum server hosting GreeterService. * * @param port - TCP port to bind (0 = random, for tests). * @param autoShutdown - install SIGTERM/SIGINT graceful-shutdown handlers. */export function buildServer(port = 5000, autoShutdown = false): Server {    return createServer({        services: [greeterService],        port,        host: "0.0.0.0",        allowHTTP1: false,        protocols: [Healthcheck({ httpEnabled: true }), Reflection()],        interceptors: createDefaultInterceptors(),        shutdown: { autoShutdown, timeout: 10_000 },    });}
+ Added− RemovedCompared with the base service

One contract edit

Make a method public. Or keep it private.

The auth module adds the JWT and authorization wiring. Then a single proto option decides whether SayHello is public.

Take it from here

Your starting point.
Not a black box.

The preview focuses on application changes. The download includes the complete project: configuration, contracts, tests, Docker and support files.

For the 1.3 release line. Dependencies are installed on your machine, not bundled.

Or scaffold with the CLI

npx @connectum/[email protected] init my-service \
  --runtime node \
  --package-manager pnpm \
  --node-exec raw \
  --yes

The CLI command covers the selected modules.

After creating the project

cd my-service
pnpm install
pnpm run start
Read the scaffolding guide →

Generated by the CLI's own transform, not a second set of templates. Source 8a6af2c ↗ · Base example v1.3.1.