Skip to content

Examples ​

Runnable reference apps live in their own repository, forinda/kickjs-examples-archive. Each one installs from npm, matches what kick new scaffolds today, passes typecheck, build and tests, and ships a Dockerfile and a "Deploy" section in its README.

bash
git clone https://github.com/forinda/kickjs-examples-archive
cd kickjs-examples-archive/<app>
pnpm install
pnpm dev

Apps that need a database or Redis include a docker-compose.yml that starts them, and list the variables they need in .env.example.

Start here ​

AppWhat it showsGuide
minimal-apiThe smallest app: one module, a controller that returns values, a createTestApp testGetting started
settings-apiConfiguration with defineSettings: app-wide, adapter-declared and module-declared sections, one adapter mounted twice with .scoped(), _FILE secrets, secrets that fail closed outside development, a generated .env.example, and the DevTools Config tabConfiguration

Data ​

AppWhat it showsGuide
task-kickdb-apikick/db on Postgres: a 17-table schema with enums and relations, generated and reviewed migrations, relational queries, the pool in an adapter with a readiness checkDatabase
multi-tenant-kickdb-apikick/db 'column' tenancy on SQLite: the tenant resolved per request, no tenant code in repositories, a JWT that lists the user's tenantsMulti-tenancy
task-drizzle-apiA full task-management API with Drizzle wired through your own adapter: JWT auth, workspace authorization on every route, queues, WebSockets, cron, Swagger in developmentBring your own
task-prisma-apiThe same API on Prisma 7Bring your own
task-mongoose-apiThe same API on MongoDB and Mongoose, with route flags (@Public) and role checksAuthorization

Frontends ​

AppWhat it showsGuide
inertia-appInertia with React and SSR: controllers return pages, validation errors go back to the form, flash messages as dismissible toasts, shared and deferred propsInertia
fullstack-appA server and a React app in one workspace: the typed client from kick typegen with no hand-written response types, 422 field errors in the form, the built web app served by the APIFullstack

Real time, files and background work ​

AppWhat it showsGuide
ws-chatWebSocket controllers: rooms, a per-room user list, token auth on connect, a heartbeat, the Redis broker across instances, a browser page to try itWebSockets
file-storage-apiUploads with size and type limits, download and delete, expiring signed URLs; local disk in development and S3 or MinIO in productionFile storage
queue-jobs-apiBullMQ jobs: @Job/@Process, dispatch that answers 202 with a job id, retries, delayed, bulk and repeating jobs, progress, a status endpoint, and a separate worker processJobs
cron-jobs-api@Cron with timezones, a run-on-boot job, overlap protection, jobs switched on and off from env, and the serverless trigger routeCron

Starting your own project ​

The examples are reference patterns, not project starters. To start a real project, scaffold with the CLI:

bash
npx @forinda/kickjs-cli new my-api
cd my-api && pnpm dev

The CLI writes tsconfig.json, vite.config.ts, kick.config.ts, a first module and the env wiring for your chosen template (rest, minimal, fullstack or inertia).

Released under the MIT License. Built with TypeScript — runs on Express, Fastify, or h3.