0
Fork 0
mirror of https://github.com/mastra-ai/mastra.git synced 2026-11-17 08:44:46 +00:00
mastra/mastracode/README.md

1.8 KiB

MastraCode contributor guide

Use this guide to find the right package and run Factory locally.

Packages

Package Responsibility
factory Factory backend: storage, routes, rules, and integrations
factory-ui Factory React application and browser tests
web Local and deployable Factory host
sdk Shared coding-agent runtime
tui Terminal interface
mastra-factory create-factory scaffolder

Setup

From the repository root:

pnpm install
pnpm --dir mastracode/web install
pnpm --dir mastracode/web run prebuild

The web host is a separate pnpm project. prebuild builds the local packages it links to.

Run Factory

First complete the local GitHub App setup.

For backend work, run the API and bundled UI together:

pnpm --dir mastracode/web dev

Open http://localhost:5873.

For UI work with hot module replacement, run the Docker services, the API, and the Vite dev server together:

pnpm --dir mastracode/web dev:ui

Open http://localhost:5173. To run them in separate terminals instead, start the Docker services with pnpm --dir mastracode/web db:up, then run pnpm --dir mastracode/web api and pnpm --filter ./mastracode/factory-ui dev.