longtao.wu/EmboFlow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
EmboFlow/README.md

1.5 KiB
Raw Blame History

EmboFlow

EmboFlow is a B/S embodied-data workflow platform for raw asset ingestion, delivery normalization, dataset transformation, workflow execution, preview, and export.

Bootstrap

From the repository root:

make bootstrap

This installs workspace dependencies and runs scripts/install_hooks.sh so local commit and push guardrails are active.

Local Commands

Run the full repository test suite:

make test

Run the strict repository guardrails:

make guardrails

Start package-level development entrypoints:

make dev-api
make dev-web
make dev-worker

Repository Structure

  • apps/api contains the control-plane modules for workspaces, assets, workflows, runs, and artifacts.
  • apps/web contains the initial shell, asset workspace, workflow editor surface, run detail view, and explore renderers.
  • apps/worker contains the local scheduler, task runner, and executor contracts.
  • design/ contains the architecture and product design documents that must stay aligned with implementation.
  • docs/ contains workflow guidance and the executable implementation plan.

Developer Workflow

  1. Read the relevant design files under design/ before editing code.
  2. Implement code and update impacted docs in the same change set.
  3. Use English-only commit messages with a gitmoji prefix.
  4. Run make test and make guardrails before pushing changes.

For direct hook installation or reinstallation:

bash scripts/install_hooks.sh