Introduction
What Flare is and how these docs are laid out.
Flare is a TypeScript application framework for Node.js and Cloudflare Workers. You register an application graph on a FlareHost: HTTP and WebSocket routes, services and their dependencies, typed configuration, and the contracts that parse what comes in. host.build() validates the whole graph and compiles it once, and the same graph runs on either runtime.
The map
Section titled “The map”| Section | Covers |
|---|---|
| Install | Packages, runtimes, project layout, flare.json |
| Tutorial | A first app, built out into a CRUD service with contracts, DI, and a test |
| Fundamentals | The arc model, build(), host, DI, config, logging, errors |
| HTTP | Routes, middleware, contracts, request state, CORS, errors |
| WebSockets | WebSocket routes, contracts, channels, connection state |
| Runtimes | Node, Cloudflare Workers, Durable Objects, Bun/Deno status |
| Schema | @flare-ts/lib primitives, DTOs, serialization |
| Testing | app.test(), service replacement, controller unit tests |
| API Reference | Generated TypeDoc for @flare-ts/core and @flare-ts/lib |
Where to start
Section titled “Where to start”New to Flare: Install, then your first app. Deciding whether to use it: Why Flare states the design decision and its trade. Migrating from 0.2: Release notes carries the breaking changes and rename tables.
Version
Section titled “Version”This site documents Flare 0.3.
Robots
Section titled “Robots”Every page ships provenance metadata and a raw Markdown form. Robots documents the machine surfaces: llms.txt, per-page .md URLs, and how grounding is recorded.