dev watch (#820)

- **add SessionTimeLimit as a userConfig setting**
- **add settings hooks**
- **apply dark mode**
- **add SessionTimeLimit as a userConfig setting**
- **fix: supply _rev for adding attachments**
- **wrap viewLookup fcn**
- **add dev-watch script**
- **exclude some packages**
- **exclude tui, cli. fix name truncation.**
- **add a build:lib script**
- **add init build to setup script, add build:pui, sui**

Author: NiloCK

package.json

@@ -1,17 +1,19 @@
 {
     "name": "vue-skuilder",
     "scripts": {
-        "setup": "yarn && git submodule update --init --recursive",
+        "setup": "yarn && git submodule update --init --recursive && yarn build:lib",
         "dev": "yarn workspace @vue-skuilder/common build && yarn workspace @vue-skuilder/db build && yarn workspace @vue-skuilder/common-ui build && yarn workspace @vue-skuilder/courses build && yarn workspace @vue-skuilder/edit-ui build && node scripts/dev-couchdb.js start && concurrently \"yarn dev:platform-ui\" \"yarn dev:express\"",
-        "dev:platform-ui": "yarn workspace @vue-skuilder/platform-ui dev",
-        "dev:express": "yarn workspace @vue-skuilder/express dev",
-        "dev:couchdb": "node scripts/dev-couchdb.js start",
+        "dev:watch": "node scripts/dev-watch.js",
+        "dev:platform": "yarn couchdb:start && yarn workspace @vue-skuilder/express dev && yarn workspace @vue-skuilder/platform-ui dev",
         "couchdb:start": "node scripts/dev-couchdb.js start",
         "couchdb:stop": "node scripts/dev-couchdb.js stop",
         "couchdb:status": "node scripts/dev-couchdb.js status",
         "couchdb:remove": "node scripts/dev-couchdb.js remove",
         "postdev": "node scripts/dev-couchdb.js stop",
         "build": "yarn workspace @vue-skuilder/common build && yarn workspace @vue-skuilder/db build && yarn workspace @vue-skuilder/common-ui build && yarn workspace @vue-skuilder/courses build && yarn workspace @vue-skuilder/edit-ui build && yarn workspace @vue-skuilder/platform-ui build && yarn workspace @vue-skuilder/express build",
+        "build:lib": "yarn workspace @vue-skuilder/common build && yarn workspace @vue-skuilder/db build && yarn workspace @vue-skuilder/common-ui build && yarn workspace @vue-skuilder/courses build && yarn workspace @vue-skuilder/edit-ui build",
+        "build:pui": "yarn build:lib && yarn workspace @vue-skuilder/platform-ui build && yarn workspace @vue-skuilder/express build",
+        "build:sui": "yarn build:lib && yarn workspace @vue-skuilder/standalone-ui build",
         "clean": "yarn clean:dist && yarn clean:node_modules",
         "clean:dist": "find packages -name 'dist' -type d -exec rm -rf {} +",
         "clean:node_modules": "find . -name 'node_modules' -type d -exec rm -rf {} +",

readme.md

@@ -11,15 +11,19 @@ Modular toolkit for the construction of interactive tutoring systems, with exper
 
 Think: the FOSS lovechild of Anki, Duolingo, Wikipedia, and MathAcademy, with a more generalized surface area for the types of content and skills that can be exercised.
 
+Also: friendly with local-first and static-deployments.
+
 ## Quick Start
 
-### For Course Creators (building *with* `vue-skuilder`) (start here!)
+### For Course Creators (building *with* `vue-skuilder`) (recommmended start point!)
 
-Install the Skuilder CLI to create your first course:
+Use the Skuilder CLI to create your first course:
 
 ```bash
-npm install -g skuilder # npx ok too!
+npm install -g skuilder
 skuilder init my-course --data-layer=static
+# Or:
+# npx skuilder init my-course --data-layer=static
 cd my-course
 npm run dev # serve your course locally
 npm run studio # edit your course content via web UI
@@ -33,10 +37,20 @@ Clone and develop the full platform:
 git clone https://github.com/patched-network/vue-skuilder.git
 cd vue-skuilder
 yarn install
-yarn setup # makes git submodule available - test database
-yarn dev # runs platform-ui, express API, and CouchDB
+yarn setup # makes git submodule available - test database, builds library packages
+```
+
+After the setup, workflows will differdepending on what you are working on. To explore, I recommend:
+
+```
+yarn dev:platform
 ```
 
+Which will build the components of the platform version of the software and serve locally.
+- database: `http://localhost:5984`, with admin accound `admin:password`.
+- express backend: `http://localhost:3000`
+- platform UI: `http://localhost:5173`
+
 ## Project Architecture
 
 This monorepo is structured to support both **platform development** and **course creation**.

scripts/dev-watch.js

@@ -0,0 +1,53 @@
+const { exec } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+const packagesDir = path.join(__dirname, '../packages');
+const packages = fs.readdirSync(packagesDir);
+const excludedPackages = [
+  // legacy / unused pkgs
+  'client',
+  'e2e-db',
+  // application packages - only used one at a time, manually started / watched by dev
+  'platform-ui',
+  'standalone-ui',
+  'studio-ui',
+  'express',
+  'tuilder',
+  // cli tool - depends on app packages
+  'cli',
+];
+
+const commands = [];
+const names = [];
+
+for (const pkg of packages) {
+  if (excludedPackages.includes(pkg)) {
+    continue;
+  }
+  const pkgPath = path.join(packagesDir, pkg, 'package.json');
+  if (fs.existsSync(pkgPath)) {
+    const pkgJson = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+    if (pkgJson.scripts && pkgJson.scripts.dev) {
+      commands.push(`"yarn workspace ${pkgJson.name} dev"`);
+      names.push(pkg);
+    }
+  }
+}
+
+if (commands.length > 0) {
+  const concurrentlyCommand = `concurrently -n "${names.join(',')}" ${commands.join(' ')}`;
+  console.log('Running command:', concurrentlyCommand);
+  const child = exec(concurrentlyCommand, (error, stdout, stderr) => {
+    if (error) {
+      console.error(`exec error: ${error}`);
+      return;
+    }
+    console.log(`stdout: ${stdout}`);
+    console.error(`stderr: ${stderr}`);
+  });
+  child.stdout.pipe(process.stdout);
+  child.stderr.pipe(process.stderr);
+} else {
+  console.log('No packages with a "dev" script found.');
+}