Prerequisites

Node.js 20+
pnpm 9+

Setup

git clone https://github.com/beatzball/litro.git
cd litro
pnpm install

Build Packages

pnpm --filter @beatzball/litro-router build
pnpm --filter @beatzball/litro build

Running Tests

# Unit tests
pnpm --filter @beatzball/litro-router test
pnpm --filter @beatzball/litro test
pnpm --filter @beatzball/create-litro test

# E2E tests (dev mode)
pnpm test:e2e

Project Structure

litro/
  packages/
    framework/          ← @beatzball/litro (core)
    litro-router/       ← @beatzball/litro-router
    create-litro/       ← npm create @beatzball/litro
  playground/           ← fullstack recipe dev environment
  playground-11ty/      ← 11ty-blog recipe dev environment
  playground-starlight/ ← starlight recipe dev environment
  docs/                 ← this documentation site
  e2e/                  ← Playwright e2e tests
  research/             ← design research documents

Submitting a PR

Fork the repository.
Create a branch: git checkout -b feat/my-feature
Make changes and add tests.
Run pnpm --filter @beatzball/litro test to verify.
Submit a pull request to main.

Release Workflow

Releases use Changesets. Add a changeset with pnpm changeset, then open a PR. The CI workflow bumps versions and publishes to npm when the changeset PR is merged.

Contributing

Prerequisites

Setup

Build Packages

Running Tests

Project Structure

Submitting a PR

Release Workflow