# Sporades

> Sporades is a CLI-first platform for building, running, inspecting, and hosting full-stack web Capsules.

Use the Start section for orientation, then choose Build or Operate by task. Links point to release-matched Markdown sources. The Optional section contains exhaustive or implementation-oriented material that can be skipped for smaller context.

## Start

- [User guide](https://mgscox.github.io/sporades/llms/user-guide.md): Orientation and task-led documentation map.
- [Build your first Capsule](https://mgscox.github.io/sporades/llms/guide/getting-started.md): Todo walkthrough from scaffold to local Container.
- [Projects and frameworks](https://mgscox.github.io/sporades/llms/guide/projects.md): Project layout, templates, frameworks, and client toolchains.

## Build

- [Server](https://mgscox.github.io/sporades/llms/guide/server.md): Schema, queries, mutations, authorization, middleware, and endpoints.
- [Client](https://mgscox.github.io/sporades/llms/guide/client.md): Subscribed queries, mutations, auth state, and framework adapters.
- [Authentication](https://mgscox.github.io/sporades/llms/guide/auth.md): Anonymous sessions, email auth, Google OAuth, and local identities.
- [Files](https://mgscox.github.io/sporades/llms/guide/files.md): Private uploads, File references, publication, replacement, and deletion.
- [Realtime](https://mgscox.github.io/sporades/llms/guide/realtime.md): App messages and consented transient User Journey state.
- [Jobs and Schedules](https://mgscox.github.io/sporades/llms/guide/background-work.md): Durable background work, actors, recurrence, and inspection.
- [Configuration](https://mgscox.github.io/sporades/llms/guide/configuration.md): Capsule config, security, Sealed Server env, preferences, and local services.

## Operate

- [Local operations](https://mgscox.github.io/sporades/llms/guide/local-operations.md): Dev and Container inspection, diagnostics, and lifecycle commands.
- [Hosting](https://mgscox.github.io/sporades/llms/guide/hosting.md): Publish and operate Capsules on a configured Host server.
- [Troubleshooting](https://mgscox.github.io/sporades/llms/guide/troubleshooting.md): Failure classification and safe recovery sequence.
- [Host server installation](https://mgscox.github.io/sporades/llms/server-installation.md): Provision and bootstrap a Linux Host server.

## Reference

- [Feature reference index](https://mgscox.github.io/sporades/llms/guide/reference.md): Compatibility index and topic map for exhaustive lookup.
- [Projects and configuration reference](https://mgscox.github.io/sporades/llms/reference/projects-and-configuration.md): Capsule creation, project layout, configuration, security policy, database services, and Dev sessions.
- [Server runtime reference](https://mgscox.github.io/sporades/llms/reference/server-runtime.md): Tables, queries, mutations, authorization, Server env, mail, middleware, actors, and endpoints.
- [Jobs and schedules reference](https://mgscox.github.io/sporades/llms/reference/jobs-and-schedules.md): Durable background work, Schedule behavior, and CLI inspection.
- [Client, authentication, and preferences reference](https://mgscox.github.io/sporades/llms/reference/client-auth-and-preferences.md): Subscribed client state, authentication workflows, provider configuration, and preferences.
- [Files and realtime reference](https://mgscox.github.io/sporades/llms/reference/files-and-realtime.md): File operations, App messages, and consented transient User Journey state.
- [Operations and hosting reference](https://mgscox.github.io/sporades/llms/reference/operations-and-hosting.md): Inspection, Container sessions, Hosted Capsules, Doctor, workflows, and troubleshooting.
- [SDK documentation](https://mgscox.github.io/sporades/llms/sdk-documentation.md): Map of conceptual guides, generated API reference, and source comments.

## Optional

- [Architecture](https://mgscox.github.io/sporades/llms/architecture.md): Runtime model, ownership, transport, storage, hosting, and security boundaries.
- [Runtime layout](https://mgscox.github.io/sporades/llms/runtime-layout.md): Generated files, persistent state, mounts, and Host paths.
- [Generated API reference](https://mgscox.github.io/sporades/api/): TypeDoc reference for the public client and server SDK.