docs: clone with submodules and run submodule init in setup

Fixes #110 — workflow-builder and ai-agent live in git submodules
(packages/Vibe-Workflow, packages/Open-Poe-AI). A plain `git clone`
leaves those directories empty, so `next build` fails to resolve
the `ai-agent` and `workflow-builder` workspace imports.

- README: instruct `git clone --recurse-submodules` and document
  the `git submodule update --init --recursive` fallback.
- package.json: prepend submodule init to the `setup` script so
  `npm run setup` works on a fresh clone too.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Anil Matcha
2026-04-25 10:24:42 +05:30
parent 8c50910863
commit abfcd2ce49
2 changed files with 6 additions and 3 deletions
+5 -2
View File
@@ -336,10 +336,13 @@ Every image you upload is saved locally (URL + thumbnail) so you never upload th
### Setup
```bash
# Clone the repository
git clone https://github.com/Anil-matcha/Open-Generative-AI.git
# Clone the repository (with submodules — required for the workflow + agent packages)
git clone --recurse-submodules https://github.com/Anil-matcha/Open-Generative-AI.git
cd Open-Generative-AI
# If you already cloned without --recurse-submodules, run this once:
# git submodule update --init --recursive
# Install dependencies (installs root + packages/studio workspace)
npm install
+1 -1
View File
@@ -17,7 +17,7 @@
"build:workflow": "npm run build -w workflow-builder",
"build:agent": "npm run build -w ai-agent",
"build:packages": "npm run build:workflow && npm run build:agent && npm run build:studio",
"setup": "npm install && npm run build:packages",
"setup": "git submodule update --init --recursive && npm install && npm run build:packages",
"vite:dev": "vite",
"vite:build": "vite build",
"electron:dev": "npm run vite:build && electron .",