WIP: work out of the box

silexlabs · Nov 19, 2024 · af2c3ca · af2c3ca
1 parent f391264
commit af2c3ca
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -25,8 +25,7 @@ There is no issue on this repo, please use the individual project's issues
 | Silex Dashboard | `packages/silex-dashboard` | `git@github.com:silexlabs/silex-dashboard.git` | Here is the source code of Silex dashboard. It is a [Silex](https://www.silex.me) plugin which can be installed to manage websites you will then edit in Silex. |
 | Silex CMS | `packages/silex-cms` | `git@github.com:silexlabs/silex-cms.git` | This is a Silex plugin to make Eleventy layouts visually with integration of any GraphQL API, allowing for a streamlined, code-free development process |
 | node_modules Path | `packages/node_modules-path` | `git@github.com:lexoyo/node_modules-path.git` | Get the path of the `node_modules` folder in your scripts or CLI or `package.json`. This is useful when you are building a library that can either be used as an npm dependency or directly, [see this question on SO](https://stackoverflow.com/questions/44279838/copy-assets-from-npm). |
-| Libre Friends | `packages/libre-friends` | `git@gitlab.com:silexlabs/libre-friends.git` | 
- |
+| Libre Friends | `packages/libre-friends` | `git@gitlab.com:silexlabs/libre-friends.git` |  |
 | Grapesjs Ui Suggest Classes | `packages/grapesjs-ui-suggest-classes` | `git@github.com:silexlabs/grapesjs-ui-suggest-classes.git` | A grapesjs plugin to enable auto-complete of classes in the SelectorManager UI  |
 | Symbols plugin for GrapesJS | `packages/grapesjs-symbols` | `git@github.com:silexlabs/grapesjs-sympbols.git` | This plugin adds feature to GrapesJS editor, for users to be able to reuse elements in a website and accross pages |
 | Grapesjs Storage Rate Limit | `packages/grapesjs-storage-rate-limit` | `git@github.com:silexlabs/grapesjs-storage-rate-limit.git` | A plugin for GrapesJS that provides rate-limited storage, allowing you to save changes immediately and then cool down for a specified period before saving again. |
@@ -55,13 +54,18 @@ To contribute to Silex you need to fork this repo then clone locally this repo w
 ```
 $ git clone git@github.com:<your github handle>/silex-meta.git --recurse-submodules -j8
 $ cd silex-meta
-$ git submodule update --init --recursive
-$ scripts/exec.js "git checkout {{branch}}" # checkout the default branch in all submodules
 $ nvm install # Get the node version from .nvmrc
 $ npm install
 $ npm start
 ```
 
+Troubleshooting:
+```
+$ scripts/exec.js "git checkout {{branch}}" # checkout the default branch in all submodules
+$ scripts/exec.js "npm install" # install dependencies in all submodules
+$ cd packages/Silex && npm run build && cd ../.. # build the Silex editor
+```
+
 Then you can open your browser at [http://localhost:6800](http://localhost:6800) to see the Silex editor running locally.
 
 When you are ready to contribute to a specific library or libraries, you can do the following:

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/Silex b/packages/Silex
diff --git a/scripts/exec.js b/scripts/exec.js
@@ -2,6 +2,7 @@
 // This script executes a command in each submodule
 // It supports replacing `{{branch}}` with the branch name
 // In most cases you will want to use `npm run exec` instead of running this script directly
+// Or `git submodule foreach --recursive 'echo "Running command in $name"'`
 const fs = require('fs');
 const { spawnSync } = require('child_process');
 
@@ -18,7 +19,6 @@ if (!command) {
 const gitmodules = fs.readFileSync('.gitmodules', 'utf8');
 const repos = gitmodules.match(/\[submodule "(.*)"\]/g).map(repo => repo.match(/\[submodule "(.*)"\]/)[1]);
 const branches = gitmodules.match(/branch = (.*)/g).map(branch => branch.match(/branch = (.*)/)[1]);
-console.log('repos:', {repos, branches});
 
 repos.forEach((repo, index) => {
   const branch = branches[index];