Skip to content

Contributor getting started

Use this path when starting from a clean FrameKit checkout. It covers repository prerequisites and the first local development run before the architecture and workflow guides.

  1. Check prerequisites, including the exact Node.js and pnpm versions required by the root contract.
  2. Follow local development to install dependencies, start Studio, and choose focused workspace commands.
  3. Read the architecture guide before changing code so the workspace and generated-output boundaries are clear.
  4. Continue with development for implementation rules. Use local development for focused workspace commands, or package architecture when a change affects a public package.

If you are setting up a generated FrameKit application rather than contributing to this repository, use user getting started instead. The contributor path does not replace the consumer setup or API references.