# Terajs

> Terajs is a compiler-native UI framework for route-first, local-first web applications. This expanded index is for LLMs and AI-enabled browsers that need the full docs map, public API routes, examples, demos, and source documents in one place.

How to use this index:

- Start with Docs when the question is about workflow, sequencing, or architectural guidance.
- Use API reference when you need exact public names, import paths, or config keys.
- Use Examples for focused code-backed patterns and Demos for runtime proof routes.
- Terajs keeps a renderer-agnostic, Terajs-native core and pushes browser, Vite, SSR, and wrapper behavior into adapters.
- Benchmark numbers on terajs.com come from production browser builds and are workload-specific.

## Docs

- [Docs overview](https://terajs.com/docs): Terajs documentation hub for installation, getting started, routing, reactivity, components, realtime sync, DevTools, deployment, examples, and API reference.
- [Why Terajs](https://terajs.com/docs/why-terajs): Positioning guide for Terajs covering compiler-native rendering, route-first structure, local-first runtime behavior, diagnostics, and adapter boundaries.
- [Philosophy](https://terajs.com/docs/philosophy): Philosophy guide for Terajs covering compiler-native rendering, neutral core package boundaries, route-first structure, local-first runtime behavior, and diagnostics as product surface.
- [Installation](https://terajs.com/docs/installation): Installation guide for Terajs covering app scaffolding, local startup, and the production build check.
- [Getting Started](https://terajs.com/docs/quickstart): Getting started guide for Terajs focused on choosing the first route-backed slice after installation and configuration.
- [Tutorials](https://terajs.com/docs/tutorials): Ordered Terajs tutorials for starter setup, local-first routes, realtime transport, and DevTools inspection.
- [Configuration](https://terajs.com/docs/configuration): Configuration guide for Terajs covering route discovery, component auto-imports, router defaults, and DevTools defaults.
- [Routing](https://terajs.com/docs/routing): Routing guide for Terajs covering nested page files, shared layouts, and navigation that mirrors the route map.
- [Meta tags](https://terajs.com/docs/meta-tags): Meta tags guide for Terajs covering route-owned browser metadata, layout merge order, head updates, and SSR reuse.
- [AI context](https://terajs.com/docs/ai-context): AI context guide for Terajs covering route-owned ai blocks, layout merge order, DevTools inspection, and VS Code bridge reuse.
- [Reactivity](https://terajs.com/docs/reactivity): Reactivity guide for Terajs covering ref, reactive, shallowRef, signal, state, and explicit derived values for route-scoped UI.
- [Components](https://terajs.com/docs/components): Components guide for Terajs covering .tera pages, meta, ai, and route blocks, layout slots, Portal, Suspense, and component patterns without framework drift.
- [Realtime Sync](https://terajs.com/docs/realtime-sync): Realtime sync guide for Terajs covering hub adapters, sync.hub configuration, and environment-scoped transport URLs.
- [DevTools](https://terajs.com/docs/devtools): DevTools guide for Terajs explaining runtime inspection, diagnostics, and how to inspect real feature routes without turning examples into tooling demos.
- [Benchmarks](https://terajs.com/docs/benchmarks): Benchmark guide for Terajs covering the current browser metrics, what the workloads measure, and how to read the numbers without over-claiming.
- [Deployment](https://terajs.com/docs/deployment): Deployment guidance for Terajs covering Cloudflare Worker assets or Pages for the static UI, dist builds, and explicit API or realtime service boundaries.

## API reference

- [API reference overview](https://terajs.com/api-reference): Terajs API reference hub for the app facade, Vite plugin, route file contracts, runtime data, router APIs, forms, adapters, and reactivity primitives.
- [App Entry API](https://terajs.com/api-reference/app-entry): Web-first app facade, Vite plugin, and DevTools API reference for Terajs covering the default imports for routing, state, data, and browser rendering.
- [Vite Plugin API](https://terajs.com/api-reference/vite-plugin): Vite integration and plugin option API reference for Terajs.
- [Configuration API](https://terajs.com/api-reference/configuration): Project config, router defaults, devtools defaults, and sync.hub API reference for Terajs.
- [SFC Components API](https://terajs.com/api-reference/sfc-components): .tera block model, route metadata, and route manifest API reference for Terajs.
- [Runtime Components API](https://terajs.com/api-reference/runtime-components): component, lifecycle, context, async runtime, and composition primitives API reference for Terajs.
- [Runtime Data API](https://terajs.com/api-reference/runtime-data): Actions, resources, mutation queues, and validation API reference for Terajs.
- [Router And Navigation API](https://terajs.com/api-reference/router-navigation): Router, loading, prefetch, and history API reference for Terajs.
- [Server Functions API](https://terajs.com/api-reference/server-functions): Server wrapper, transport, and request handler API reference for Terajs.
- [Forms And Links API](https://terajs.com/api-reference/forms-and-links): Form, link, pending navigation, and web router context API reference for Terajs.
- [TSX Components API](https://terajs.com/api-reference/tsx-components): TSX authoring, component runtime behavior, and custom element API reference for Terajs.
- [React Wrapper API](https://terajs.com/api-reference/react-wrapper): TerajsWrapper and useTerajsResource API reference for React integration.
- [Vue Wrapper API](https://terajs.com/api-reference/vue-wrapper): mountTerajs, TerajsDirective, and useTerajsResource API reference for Vue integration.
- [Signals](https://terajs.com/api-reference/reactivity-signals): Signal, state, computed, ref, reactive, and shallowRef API reference for Terajs reactivity.
- [Effects](https://terajs.com/api-reference/reactivity-effects): Effect, watch, and watchEffect API reference for Terajs reactivity.

## Examples

- [Examples overview](https://terajs.com/examples): Terajs examples hub covering route-backed fundamentals, core product workflows, and advanced transport or interop patterns.
- [State And Computed](https://terajs.com/examples/state-and-computed): State and computed example for Terajs showing explicit local updates and derived values on a real route.
- [Form With Validation](https://terajs.com/examples/form-with-validation): Form validation example for Terajs with schema validation, form status feedback, and queue-ready submissions.
- [Resource Fetching](https://terajs.com/examples/resource-fetching): Resource fetching example for Terajs covering source-driven reads, loading states, and explicit refetch behavior.
- [Local-first workspace](https://terajs.com/examples/counter-workspace): Local-first workspace example for Terajs showing drafts, pending mutations, and sync state on a believable screen.
- [Server Functions](https://terajs.com/examples/server-functions): Server functions example for Terajs showing server wrapper usage, context handling, and client-server execution seams.
- [SignalR collaboration](https://terajs.com/examples/realtime-sync): SignalR collaboration example for Terajs explaining connection setup, runtime state, and the deployment boundary.
- [Prefetch And Navigation](https://terajs.com/examples/prefetch-and-navigation): Prefetch and navigation example for Terajs showing pending route UI, prefetch links, and transition feedback.
- [Route Guards And Redirects](https://terajs.com/examples/route-guards-and-redirects): Route guard and redirect example for Terajs showing policy-driven navigation decisions and protected route flows.
- [AI Chatbot](https://terajs.com/examples/ai-chatbot): App-facing AI chatbot example for Terajs showing a safe request client, typed actions, and route-scoped metadata on a believable feature route.
- [Socket.IO collaboration](https://terajs.com/examples/socketio-collaboration): Socket.IO collaboration example for Terajs showing realtime transport integration with queue-aware runtime behavior.
- [WebSocket collaboration](https://terajs.com/examples/websocket-collaboration): WebSocket collaboration example for Terajs showing raw socket transport with the same runtime invalidation seam.
- [Offline queue replay](https://terajs.com/examples/offline-queue-and-replay): Offline queue replay example for Terajs showing queued mutation durability, retry behavior, and replay after reconnect.
- [Custom Elements](https://terajs.com/examples/custom-elements): Custom elements example for Terajs showing browser-native component registration and cross-stack embedding.
- [Slots, Portal, and Suspense](https://terajs.com/examples/slots-portal-suspense): Composition primitives example for Terajs showing layout slots, Portal for out-of-tree UI, and the current Suspense boundary model.
- [Error Boundaries](https://terajs.com/examples/error-boundaries): Error boundaries example for Terajs showing subtree failure isolation with withErrorBoundary() and explicit fallback rendering.
- [React integration](https://terajs.com/examples/react-component-integration): React integration example for Terajs showing adapter-based incremental hosting with TerajsWrapper.
- [Vue integration](https://terajs.com/examples/vue-component-integration): Vue integration example for Terajs showing adapter-based incremental hosting with TerajsDirective.
- [DevTools Inspection](https://terajs.com/examples/devtools-inspection): DevTools inspection example for Terajs showing runtime overlay diagnostics and explicit VS Code bridge attachment.

## Demos

- [Demos overview](https://terajs.com/demos): Terajs demos hub describing the rebuild toward real proof routes and pointing to the benchmark and example surfaces that are credible today.

## Structured route manifest

- [Route manifest](https://terajs.com/route-manifest.json): Machine-readable route metadata with titles, descriptions, canonicals, route leaf ids, and AI summaries plus tags.

## Architecture and repo docs

- [README](https://raw.githubusercontent.com/terajs/terajs/main/README.md): Public repo overview in markdown.
- [API_REFERENCE.md](https://raw.githubusercontent.com/terajs/terajs/main/API_REFERENCE.md): Long-form API reference source.
- [COMPONENTS.md](https://raw.githubusercontent.com/terajs/terajs/main/COMPONENTS.md): Component model and patterns.
- [Core_Philosophy.md](https://raw.githubusercontent.com/terajs/terajs/main/Core_Philosophy.md): Core architecture commitments.
- [VISION.md](https://raw.githubusercontent.com/terajs/terajs/main/VISION.md): Long-range framework direction.
- [RENDERER_ARCHITECHTURE.md](https://raw.githubusercontent.com/terajs/terajs/main/RENDERER_ARCHITECHTURE.md): Renderer pipeline and boundaries.
- [Benchmark harnesses](https://github.com/terajs/terajs/tree/main/benchmarks): Browser benchmark source and reproducibility entry point.

## Optional

- [Concise LLM index](https://terajs.com/llms.txt): Shorter curated index.
- [GitHub repository](https://github.com/terajs/terajs): Source code, packages, issues, and releases.