Examples Overview

The VentureKit repository includes complete working examples that demonstrate each major feature. Each example is a self-contained project you can run locally.

Available Examples

• Minimal — Basic API with health check and echo endpoints. The simplest possible VentureKit project.
  • REST API — Full REST API with CRUD operations, scoped endpoints, and file-based routing.
  • Authentication — Cognito integration, RBAC, scope checking, JWT utilities, and admin endpoints.
  • Database — PostgreSQL with RDS, Drizzle migrations, queries, and transactions.
  • Storage — S3 buckets with CDN, versioning, and lifecycle policies.
  • Multi-Tenancy — Tenant resolution, context, data isolation, and quota enforcement.
  • AI — Embeddings, vector stores, RAG pipelines, and agents with tool use.
  • Billing — Plan definitions, feature limits, and usage-to-invoice mapping.
  • WebSocket — Real-time WebSocket API with two-phase auth and connection management.
  • Infrastructure Intents — Declarative databases, storage, queues, caches, and schedules.

Running Examples

All examples live in the examples/ directory of the monorepo. To run one:

cd examples/<name>
npm install
vk dev

Minimum Packages

Every example uses at least:

@venturekit/core     — types and config
@venturekit/runtime  — handlers
@venturekit/infra    — infrastructure

Feature-specific examples add the relevant package (e.g., @venturekit/auth, @venturekit/data).