Examples and templates for Connectum framework

Framework · Documentation · Quickstart

---

Ready-to-run examples demonstrating Connectum features — from a one-service quickstart to a monolith-or-microservices HR system and an enterprise car-sharing deployment on Kubernetes + Istio.

Examples

Example	Description	Highlights	Status
getting-started	Quickstart — one service	defineService, health, reflection, default interceptors, graceful shutdown; Node/Bun/tsx	Ready
performance-test-server	k6 benchmarking server	5 parallel servers, interceptor overhead measurement, ports 8080-8084	Ready
extensions/redact	Sensitive data redaction	Proto custom field options, createRedactInterceptor()	Ready
interceptors/jwt	Client-side JWT interceptor	Bearer token injection, createAddTokenInterceptor()	Ready
with-custom-interceptor	Echo service with custom interceptors	API key auth, rate limiting	Ready
hris	Monolith or microservices — one codebase	defineService + catalog + ctx.call (in-process vs remote by env) + EventBus saga	Ready
car-sharing	Enterprise deploy — Kubernetes + Istio	Split microservices + JWT/proto authz gateway + OpenTelemetry; k8s/Istio manifests (mTLS, canary)	Ready
with-events-kafka	EventBus with Kafka	Event-driven microservices, consumer groups	Ready
with-events-redpanda	EventBus with Redpanda	Saga choreography, custom topics, Redpanda Console	Ready
with-events-valkey	EventBus with Valkey (Redis)	Redis Streams adapter, lightweight event bus	Ready
with-events-amqp	EventBus with RabbitMQ	AMQP adapter, topic exchange, Management UI	Ready
with-events-dlq	EventBus Dead Letter Queue	DLQ service, retry policies, failed event inspection	Ready
o11y-coroot	Observability with Coroot	Distributed tracing, custom metrics, structured logs, service map	Ready

Prerequisites

• Node.js >= 22.13.0, or Bun >= 1.3.6, or tsx >= 4.21 (for TypeScript source in your project)
• pnpm >= 10

Quick Start

git clone https://github.com/Connectum-Framework/examples.git
cd examples/getting-started
pnpm install
pnpm dev

The greeter service starts on port 5000 with gRPC Health Check, Server Reflection, and default interceptors enabled.

Test with grpcurl:

grpcurl -plaintext -d '{"name": "World"}' localhost:5000 greeter.v1.GreeterService/SayHello

Enterprise deployment

The car-sharing example demonstrates a split-microservices deployment with a JWT/proto-authz gateway and OpenTelemetry, plus the manifests to run it:

• Kubernetes — per-service Deployment / Service / HPA / RBAC, single role-selectable image (SERVICES env), perServiceEnvResolver wiring cross-service ctx.call across pods.
• Istio — PeerAuthentication mTLS (STRICT), AuthorizationPolicy, VirtualService / DestinationRule, a canary example.

See car-sharing/README.md for details.

Dependencies

The catalog examples (getting-started, hris, car-sharing) use the 1.0.0 service-catalog API, which is published on npm — install them with pnpm install like the other examples. Every example uses published @connectum/* packages from npm, so pnpm install is all you need.

License

Apache License 2.0 · Built by Highload.Zone