Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 2.15 KB

README.md

File metadata and controls

41 lines (29 loc) · 2.15 KB

Project Igniter Documentation

Project Igniter is a desktop application that lets maintainers model project setup as a visual workflow and generate zero-dependency setup scripts (Bash + PowerShell) from it. Contributors run a single command — bash setup.sh — and get walked through the whole setup.

This directory is the canonical reference for how Project Igniter works internally and how to use it.

Start Here

Document What it covers
Architecture How the data model, editor, converter, and orchestrator interlock
Working with the Composer First-run flow and the three-panel editor layout
Authoring a workflow Designing steps, branches, variables, and OS handling
Generated scripts What the converter produces and how contributors run it
Monorepo & projects Managing multiple projects/environments in one repo
Contributing Setting up the app for development and process

Reference

Document What it covers
Step types Every step, its fields, branches, and generated code
Index & storage schema .project-igniter/, workflows.json, state directory
Orchestrator flags setup.sh / setup.ps1 CLI and behaviours

Patterns

Document What it covers
Recursive tree utilities The find/update/delete/move/add helper family
State-machine dispatch How generated scripts run as a NEXT state machine
OS merge (Same as) Deduplicating branches with mergeFrom

Decision Records

See adr/ for architecture decision records.

Related Links