Documentation

Sketch an idea in English, watch Heartwood draft the schema, write the code, and ship it. These docs show you how.

Getting started

Heartwood turns a sentence into a running app. Sign in, describe what you want, and watch a full-stack project take shape in under a minute.

A sixty-second tour

Open the studio, type a sentence into the prompt card, and press Build. Heartwood will pick a stack, draft the schema, write the pages, and give you a live preview URL before you've finished your coffee.

promptbuild me a cozy bookshelf where I can track what I'm reading
and share reviews with friends. include a rating system and a
monthly reading streak.

No credit card. The hobby tier is free forever. Paid tiers unlock custom domains and team features — see pricing.

What you get on day one

  • A typed Next.js or Remix project (your choice)
  • A Postgres schema with seeded sample data
  • Passwordless auth wired up
  • A working preview URL on a Heartwood subdomain
  • Full source code, exportable at any time

Installation

You don't install Heartwood — it lives in the browser. But if you want local development, the Heartwood CLI mirrors the studio to your machine.

Browser studio

The fastest path. Visit heartwood.dev, sign in, and you're building.

Local CLI (optional)

shell$ npm install -g @heartwood/cli
$ heartwood login
# opens a browser, auths, returns
$ heartwood pull my-bookshelf
# downloads the project into ./my-bookshelf

Requirements

  • Node.js 20 or later
  • A modern browser (Safari 17+, Chrome 120+, Firefox 120+)
  • That's it.

API reference

Every Heartwood app ships with a REST API you can extend, and a Heartwood platform API for programmatic project management.

Your app's API

Heartwood generates REST endpoints from your schema. For a Book model, you get:

  • GET /api/books — list
  • POST /api/books — create
  • GET /api/books/:id — read
  • PATCH /api/books/:id — update
  • DELETE /api/books/:id — delete

Platform API

bash$ curl https://api.heartwood.dev/v1/projects \
  -H "Authorization: Bearer $HEARTWOOD_TOKEN"

Response

json{
  "projects": [
    {
      "id": "prj_k4m3r",
      "name": "my-bookshelf",
      "url": "https://my-bookshelf.heartwood.app",
      "created_at": "2026-04-18T14:02:00Z"
    }
  ]
}

Templates

Every template on the homepage is a fully-working app, not a starter. Fork one, rename it, and you're live.

  • Pocket Journal — private writing with daily prompts and mood tracking.
  • Studio Portfolio — a creator's gallery with project pages and a contact form.
  • Member Club — invite-only community with posts, comments, and events.
  • Bookshop — Stripe-wired storefront with inventory.
  • Team OS — internal dashboard for runbooks, updates, and on-call rotations.
  • Reading Room — editorial CMS with article scheduling and newsletter capture.

Configuration

Most projects never touch heartwood.config.json. When you do, it's the single source of truth.

json{
  "framework": "next",
  "database": {
    "provider": "postgres",
    "branch": "main"
  },
  "auth": {
    "providers": ["email", "google", "github"]
  },
  "deploy": {
    "target": "vercel",
    "domain": "bookshelf.yourdomain.com"
  }
}

Environment variables

  • HEARTWOOD_TOKEN — your personal API token, used by the CLI.
  • HEARTWOOD_PROJECT — default project for CLI commands.

Secrets. Environment variables set in the studio are encrypted at rest and never logged. Rotate a secret any time — rollouts are zero-downtime.