Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Added
- Initial README + CHANGELOG + CONTRIBUTING (QoL sweep follow-up).

## [0.60.3]

Initial CHANGELOG entry tracking the current release. See git tags for prior versions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing to workflow-editor

This project is part of the [GoCodeAlone/workflow](https://github.com/GoCodeAlone/workflow) ecosystem.

## Before contributing

Read the [upstream CONTRIBUTING.md](https://github.com/GoCodeAlone/workflow/blob/main/CONTRIBUTING.md) for general conventions, signing, and review expectations.

## Local development

```sh
git clone https://github.com/GoCodeAlone/workflow-editor.git
cd workflow-editor
npm install
npm run dev
npm test
```
Comment on lines +9 to +17

## Pull requests

- One feature or bugfix per PR.
- Update CHANGELOG.md with a Keep-a-Changelog entry.
- Add vitest tests for new components or store logic.
- Add Playwright E2E tests where appropriate.

## Reporting issues

See the issue templates under `.github/ISSUE_TEMPLATE/`.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# workflow-editor

> 🎨 Visual editor for the [GoCodeAlone/workflow](https://github.com/GoCodeAlone/workflow) engine.

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![npm](https://img.shields.io/npm/v/@gocodealone/workflow-editor.svg)](https://github.com/orgs/GoCodeAlone/packages?repo_name=workflow-editor)
Comment on lines +5 to +6

Standalone npm package providing a visual workflow editor: 14 node types, 9 edge types, a ReactFlow canvas, property panel, node palette, toolbar, serialization, and auto-layout. Used by `workflow-vscode`, `workflow-jetbrains`, and embeddable in any TypeScript/React host.

## What it provides

- **WorkflowCanvas** — ReactFlow-based visual canvas
- **PropertyPanel** — type-specific node configuration
- **NodePalette** — drag-and-drop palette across all 90+ module types
- **Toolbar** — load, save, validate, deploy
- **Serialization** — YAML ↔ graph round-trip
- **autoLayout** — automatic graph layout
- **Zustand stores** — `loadSchemas()` / `loadPluginSchemas()` for host injection

## Install

```sh
npm install @gocodealone/workflow-editor
```
Comment on lines +20 to +24

```ts
import { WorkflowCanvas, useWorkflowStore } from '@gocodealone/workflow-editor';
```

## Local development

```sh
git clone https://github.com/GoCodeAlone/workflow-editor.git
cd workflow-editor
npm install
npm run dev
npm test
```
Comment on lines +30 to +38

Build: `npm run build` (Vite library mode).

## Documentation

- [workflow engine upstream](https://github.com/GoCodeAlone/workflow)
- [Design plan](https://github.com/GoCodeAlone/workflow/blob/main/docs/plans/2026-03-12-workflow-editor-design.md)
- [Host integrations](https://github.com/GoCodeAlone/workflow-vscode), [JetBrains](https://github.com/GoCodeAlone/workflow-jetbrains)

## CI

- `publish.yml` — tag → build → publish → dispatch editor-release
- `sync-schema.yml` — workflow-release → update types

## License

MIT. See [LICENSE](LICENSE).
Loading