Skip to content

Docs

Documentation for installing Homestead and building your own apps on it. Want inspiration? See the example apps.

Getting Started

  • Installation — install the CLI and run your first instance.
  • Quick Start — build a "Hello World" app and add it to your instance.

App Development

What an app can do beyond rendering a page.

  • App Config — the field-by-field reference for the AppConfig manifest every app exports.
  • Defining Resources — declare the data your app stores and get a REST API for it.
  • State Management — read and write resources with the built-in data layer.
  • Dashboard Widgets — add a summary card to the home dashboard.
  • App Flags — typed, household-wide settings an app can declare and read.
  • Notifications — send push notifications to users.
  • Bulk Import — add CSV import to an app.
  • AI Support — work with your data from the CLI, Chat, and MCP clients.

Using Homestead

Running an instance for your household.