Documentation
Find KetJS contracts by responsibility, from module composition and request execution to data, rendering and runtime operations.
Find your entry point#
KetJS 0.2.0 is in preview
The project is in active review. Use it for evaluation and feedback, expect API and data-format changes before 1.0, and avoid production workloads for now.
For step-by-step projects, follow Learn KetJS. These Docs explain the contracts behind those projects and provide a reference when you are building your own application. To run a first application, read:
- Installation and quick start — scaffold and run a working SQLite application.
- Directory structure — locate module declarations, workspace configuration and emitted artifacts.
- Configuration — select the workspace, deployment and runtime services.
Browse by KetJS responsibility#
Find the contract you need below. Each group follows one KetJS responsibility, with its guides listed in reading order. Start with composition, then follow a request through data, identity and rendering; verification and deployment bring those contracts together.
Set up KetJS#
Create a runnable project and understand its files and settings.
Application composition#
Define a module, select a deployment's modules in a workspace, then learn how named modules resolve from filesystem roots.
Request execution#
Follow a request through its context, server functions and HTTP boundary. Validate form input and describe the public HTTP contract.
Data contracts#
Declare models and scopes, prepare the schema with the selected adapter, then read and change data through validated operations.
Identity and access#
Resolve sessions and tenant context before deciding which operations the current identity may execute. Read this group alongside data scopes when building a tenant application.
ketjs-view and KTL#
Understand pure rendering and island lifecycles, then choose browser data loading, a static site or server theme templates. Menus, localization and reports build on those output contracts.
Runtime services#
Run durable work outside the request, connect storage and transports, and record operational events. These services belong to the selected deployment.
Verify and deploy#
Test the actual deployment, interpret workload-specific measurements, then build and operate its HTTP and worker processes.
API and tooling#
Look up an exported API, CLI command or configuration field once you know which contract you need.
Project evolution#
Check the current package boundaries and upgrade requirements. Review design decisions and unresolved questions before contributing or publishing framework packages.
Follow a task#
| Goal | Reading path |
|---|---|
| A fullstack application | Modules → Workspaces → Server functions → HTTP routes |
| A data workflow | Models → Migrations → Query builder |
| An interactive view | Rendering and islands → Effects and data fetching → Form validation |
| A static or client-rendered site | Rendering and islands → Static sites with ketjs-view → Runnable example |
| A secure tenant application | Sessions and tenants → Authorization → Model scopes |
| Background and integration work | Jobs and workers → Storage, transports and streams |
Framework and ecosystem#
This site documents KetJS. KetSuite, its design system, Flow and product clients use the framework but have their own source, releases and documentation. See Release notes for the package boundaries.
Use Learn KetJS for guided exercises, the Playground for browser experiments, and the Blog for explanations of the engineering choices behind these contracts.