# AOZUMI Fold

> Fold is an npm package and CLI (`@aozumi/fold`) for building a small full-stack TypeScript app and publishing it to `https://<name>.aozumi.site` in about a second, with no account.

Start with the first page. Each link is plain Markdown.

## Docs

- [AOZUMI Fold](https://docs.aozumi.dev/fold/index.md): Fold is an npm package and CLI (`@aozumi/fold`) for building a small full-stack TypeScript app and publishing it to `https://<name>.aozumi.site` in about a second, with no account.
- [CLI](https://docs.aozumi.dev/fold/cli/index.md): Every `npx @aozumi/fold` command, and whether it works today.
- [Fold API](https://docs.aozumi.dev/fold/fold-api/index.md): How to define a fold's server: `fold()`, the schema, queries, mutations, actions, endpoints, and the `ctx` every handler receives.
- [Client](https://docs.aozumi.dev/fold/client/index.md): The browser side of a fold: the typed client, query and mutation hooks, live updates, pagination, errors, and routing.
- [Database](https://docs.aozumi.dev/fold/database/index.md): The `ctx.db` API: insert, get, update, delete, and index queries with ranges, order, `take`, `first`, `collect`, `count`, and `paginate`.
- [Sharing data by link](https://docs.aozumi.dev/fold/sharing/index.md): How to build data that several people share, like a flat's grocery list, a team poll or a trip budget, opened with an unguessable link.
- [Schema changes](https://docs.aozumi.dev/fold/database-migration/index.md): What happens to existing data when you change the schema and redeploy, and how to move an older fold to the async database API.
- [Auth](https://docs.aozumi.dev/fold/auth/index.md): Who is calling: guest sessions, `ctx.auth` guards, Google sign-in from the client, and what a user ID means in Fold.
- [Storage](https://docs.aozumi.dev/fold/storage/index.md): The client API for user file uploads. It works in local dev. File storage for hosted folds is not available yet.
- [Limits](https://docs.aozumi.dev/fold/limits/index.md): Every limit and rule for anonymous (unclaimed) folds, the error each one produces, and how to fix it.
- [Reference](https://docs.aozumi.dev/fold/reference/index.md): Every export of every `@aozumi/fold` entry point (v0.1.0), one line each.