# Goribu

> A full-stack React framework for Cloudflare Workers, built for humans and coding agents.

Use the individual Markdown guides below for focused questions. The complete documentation includes every guide and both TypeScript and JavaScript application examples. Goribu configuration and the required browser entry use JavaScript.

- [Complete documentation](https://goribu.dev/llms-full.txt): All guides in one file.

## start here

- [Introduction](https://goribu.dev/docs/index.md): Meet Goribu, a full-stack React framework for Cloudflare Workers built for delighful development by humans and AI coding agents.

- [At a glance](https://goribu.dev/docs/at-a-glance/index.md): Get started with Goribu: routes, forms, navigation, metadata, D1, KV, and deployment in one practical overview.

- [Installation](https://goribu.dev/docs/installation/index.md): Start with a small React app that runs locally on the Workers runtime.

- [AI coding](https://goribu.dev/docs/agents/index.md): Give your agent a small set of conventions and a clear description of what the app should do.

- [Tutorial](https://goribu.dev/docs/tutorial/index.md): Build a small feedback app with a D1 table, a form, validation, and a list of saved messages.

## routing

- [Routes](https://goribu.dev/docs/routing/index.md): A file in `src/routes/` defines a URL, its page, and any request handlers it needs.

- [Request handlers](https://goribu.dev/docs/handlers/index.md): Read the request, do server work, and return the response the user should receive.

- [Rendering](https://goribu.dev/docs/rendering/index.md): Send useful HTML first, then hydrate the page for interaction and navigation.

- [Links & navigation](https://goribu.dev/docs/navigation/index.md): Use real links for navigation and let Goribu enhance them after hydration.

- [Forms](https://goribu.dev/docs/forms/index.md): Submit to a route handler and render pending state, validation errors, and results beside the fields.

- [Errors](https://goribu.dev/docs/errors/index.md): Give visitors a useful response while keeping the details you need to debug.

## data

- [Database: D1](https://goribu.dev/docs/d1/index.md): Declare a database in your config, then query it directly from request handlers.

- [Database: Bring your own](https://goribu.dev/docs/databases/index.md): Use D1 for the built-in workflow, or connect to a service through an API that runs on Workers.

- [KV store](https://goribu.dev/docs/kv/index.md): Store cached or shared values when a briefly stale read is acceptable.

- [Cache](https://goribu.dev/docs/cache/index.md): Cache JSON values with req.cache, refresh after mutations, and choose a freshness window for local Cloudflare caches.

- [R2 files & uploads](https://goribu.dev/docs/r2/index.md): Store public media and private files in R2, upload from React forms, and issue signed download links.

## ship

- [Configuration](https://goribu.dev/docs/configuration/index.md): Keep deployment identity and supported resources in one Node-loadable config file.

- [Deploys](https://goribu.dev/docs/deployment/index.md): Review the target, then let Goribu build and publish your Worker and static assets.

## reference

- [Recipes](https://goribu.dev/docs/recipes/index.md): Small patterns you can adapt without introducing another layer of application machinery.

- [Complete API reference](https://goribu.dev/docs/api-reference/index.md): The public framework surface in one place. Follow the linked guides for examples and behavior in context.