mirror of
https://github.com/storytold/autocraft.git
synced 2026-11-21 15:00:54 +01:00
1.3 KiB
1.3 KiB
Contributing to AutoCraft
Project Structure
AutoCraft uses a TypeScript backend with a SQLite database and a separate web frontend. Refer to the README for setup, pipeline documentation for stage details, and operations for running the service.
Key directories:
src/cli.ts: CLI entry point.src/runner/: Pipeline execution.src/stages/registry.ts: Stage definitions.src/github/write.ts: GitHub API writes.src/dash/andweb/: Dashboard and frontend.test/: Test suite.
Local Development
package.json declares Node >=24 and the project’s pnpm version. These commands are available:
pnpm test # Run the test suite
pnpm check # TypeScript and generated-document checks
pnpm docs # Regenerate marked documentation blocks
pnpm -C web dev # Frontend development server with mock data; no backend integration
To test backend integration, build the frontend without VITE_MOCK=1 and follow the dashboard setup. The operations guide explains how the backend serves the frontend build.
The documentation generator updates marked blocks in the README and docs/pipeline.md; it does not validate the surrounding prose.