Kitten

Reference

This reference lists the features of Kitten. Each page covers one topic.

For a comprehensive ā€œowner’s manualā€-style technical reference of how Kitten is designed and works internally, please see the Technical Manual.

Getting started

What Kitten is and how to get up and running with it.

Glossary

Terms used in Kitten and the documentation.

JavaScript and TypeScript

Available languages and type safety.

HTML

Kitten’s progressively-enhanced HTML tagged templates and Streaming HTML workflow.

Components

Components and event handling.

Markdown

Kitten’s enhanced Markdown support.

Icons

Finding, using, and extending Kitten’s icon components.

Client-side libraries

Libraries Kitten serves by default (htmx, Alpine.js, Water, crypto, etc.)

File types

Kitten’s naming convention-based file system routing.

HTTP routes

GET, POST, and other HTTP routes, authorisation, and the request and response helpers.

Route parameters

Named, optional, and wildcard parameters, and route order matching.

WebSocket routes

Socket routes and the default page socket on live pages.

URLs and redirects

URL normalisation, reserved Kitten routes, redirects, the Evergreen Web, and archives.

Database

Kitten’s built-in JavaScript database (JSDB), and other data scopes.

Sessions and authentication

Sessions, signing in, and authenticated routes.

Uploads

Receiving files, upload limits, and serving uploaded files privately and publicly.

App modules

A way to organise and share code between routes, and strongly type your databases.

Command-line interface

CLI commands for launching the Kitten server and much more besides.

Interactive shell

A REPL for inspecting and modifying the state of a running Kitten app.

Logs

Sectioned logs, and the lifecycle and event logs.

Deployment

Deploy your app with automatic updates, webhooks, and versioning.

Troubleshooting

Known problems and solutions.

The kitten global

Properties of the global kitten object, and the introspection API.

Cryptography

The cryptography API, its cryptographic properties, and the threat model.

Working on Kitten

Building, debugging, profiling, testing, and releasing Kitten itself.

Questions?

Contact Aral on the fediverse.

Like this? Fund us!

Small Technology Foundation is a tiny, independent not-for-profit.

We exist in part thanks to patronage by people like you. If you share our vision and want to support our work, please become a patron or donate to us today and help us continue to exist.