Skip to content

development.md

Latest commit

 

History

History
87 lines (59 loc) · 1.69 KB

development.md

File metadata and controls

87 lines (59 loc) · 1.69 KB

Development Guide

This repository is a local-first monorepo for Skill Graph.

Prerequisites

  • Node 20+
  • npm 10+
  • Python 3.9+

If you use a version manager, the repository includes:

  • .nvmrc
  • .node-version

Install

npm install

Common Commands

Run the full local stack:

npm run dev

Run a single app or package:

npm run dev:core
npm run dev:server
npm run dev:web

Run the full verification pass:

npm run check

Or run the steps individually:

npm run lint
npm test
npm run build

Project Layout

  • apps/web: React + Vite UI
  • apps/server: local Fastify API
  • packages/core: schema, loaders, previews, and graph helpers
  • skills/skill-graph-generator: bundled standalone generator skill
  • sample-skills: local fixtures for development and demos

Recommended Local Flow

  1. npm install
  2. npm run dev
  3. Open the local Vite URL
  4. Load sample-skills
  5. Inspect basic-skill

Working With Sample Skills

  • sample-skills/basic-skill is the canonical demo fixture for the action-flow canvas
  • sample-skills/risky-skill is intentionally unsafe and should not be executed

Generator Contract

The repository expects a single graph schema:

  • version: "2.0"
  • flow.nodes
  • flow.edges

If you change the bundled generator skill, run the root test suite before submitting changes.

Notes For Contributors

  • Keep the local API bound to localhost unless you are intentionally testing another deployment model.
  • Prefer extending the shared @skill-graph/core types before patching web/server behavior ad hoc.
  • Keep UI changes consistent with the current visual system instead of mixing component styles.