Reference sections
Reference › Working on Kitten
If you’re working on Kitten itself, the Build and release section of the Technical Manual covers how to build, install, and release Kitten.
To run Kitten with the Node.js debugger (INSPECT=true), see the Debugging recipes in the Technical Manual.
To see how long your pages take to import and render (PROFILE=true), or to generate a flame graph (FLAME_GRAPH=true), see the Debugging recipes in the Technical Manual.
Kitten’s test suites, and the npm scripts that run them, are described in the Testing section of the Technical Manual.
To release a new version of Kitten to kittens.small-web.org, see Releasing in the Technical Manual.
| Dependency | Purpose |
|---|---|
| @small-tech/https | Drop-in replacement for Node’s native https module with automatic TLS for development and production using @small-tech/auto-encrypt and @small-tech/auto-encrypt-localhost. |
| @small-tech/jsdb | Zero-dependency, transparent, in-memory, streaming write-on-update JavaScript database that persists to JavaScript transaction logs. |
| Polka@next | Native HTTP server with added support for routing, middleware, and sub-applications. Polka uses Trouter as its router. |
| tinyws | WebSocket middleware for Node.js based on ws. |
| sanitize-html | Clean up untrusted HTML, preserving whitelisted elements and whitelisted attributes on a per-element basis. Built on htmlparser2 for speed and tolerance |
| simple-git | Git client used in deployments and for handling automatic updates in production. |
| sade | A small command-line interface (CLI) framework that uses mri for its argument parsing. |
| @noble/curves | Cryptography: converting Ed25519 keys to X25519 keys, deriving Ed25519 and X25519 public keys, and the X25519 key exchange in kitten.crypto.getSharedSecret(). (Signing, encryption key agreement, and key derivation use the Web Crypto API.) |
| @noble/ciphers | Cryptography: XChaCha20-Poly1305 encryption. |
| ed25519-keygen | Cryptography: SSH key generation from ed25519 key material. |
Kitten’s renderer is built upon xhtm and vhtml although both of those libraries have been inlined and extended.
For an automatically-generated full list of modules and contributors, please see CONTRIBUTORS.md.