@tangle-network/starter-foundry 0.5.3 → 0.7.0

package/registry/families/hls-origin/manifest.json

@@ -0,0 +1,159 @@
+{
+  "id": "hls-origin",
+  "description": "HLS live streaming origin — FFmpeg transcodes an RTMP ingest or file into a segmented .m3u8 playlist; Nginx serves segments with CORS so browser HLS.js or native Safari players can pull directly. Node control plane lists active streams.",
+  "tags": [
+    "hls",
+    "video",
+    "streaming",
+    "rtmp",
+    "ffmpeg",
+    "nginx",
+    "typescript",
+    "docker"
+  ],
+  "taxonomy": {
+    "language": "typescript",
+    "runtime": "node",
+    "surface": "api"
+  },
+  "defaults": {
+    "projectType": "api",
+    "serviceName": "starter-foundry-hls",
+    "port": 8099,
+    "nginxPort": 8080,
+    "rtmpPort": 1935,
+    "segmentDurationSec": 2,
+    "playlistSize": 6
+  },
+  "files": [
+    {
+      "source": "files/package.json",
+      "target": "package.json"
+    },
+    {
+      "source": "files/tsconfig.json",
+      "target": "tsconfig.json"
+    },
+    {
+      "source": "files/docker-compose.yml",
+      "target": "docker-compose.yml"
+    },
+    {
+      "source": "files/nginx.conf",
+      "target": "nginx.conf"
+    },
+    {
+      "source": "files/start-stream.sh",
+      "target": "start-stream.sh"
+    },
+    {
+      "source": "files/validate-hls.mjs",
+      "target": "validate-hls.mjs"
+    }
+  ],
+  "validationChecks": [
+    {
+      "type": "file-exists",
+      "path": "src/server.ts"
+    },
+    {
+      "type": "file-exists",
+      "path": "nginx.conf"
+    },
+    {
+      "type": "file-exists",
+      "path": "docker-compose.yml"
+    },
+    {
+      "type": "file-exists",
+      "path": "start-stream.sh"
+    },
+    {
+      "type": "command-success",
+      "command": [
+        "node",
+        "validate-hls.mjs"
+      ],
+      "expect": "hls-origin starter ok"
+    }
+  ],
+  "contextHints": {
+    "commands": [
+      "pnpm install",
+      "docker compose up -d",
+      "pnpm run dev",
+      "./start-stream.sh <input-file-or-rtmp-url> demo",
+      "open http://localhost:{{nginxPort}}/hls/demo/stream.m3u8"
+    ],
+    "entrypoints": [
+      "src/server.ts",
+      "nginx.conf",
+      "start-stream.sh",
+      "docker-compose.yml"
+    ],
+    "preview": {
+      "path": "/health"
+    },
+    "extensionPoints": [
+      "nginx.conf",
+      "start-stream.sh",
+      "src/server.ts"
+    ]
+  },
+  "keywords": [
+    "hls",
+    "hls server",
+    "hls origin",
+    "m3u8",
+    "live streaming",
+    "rtmp",
+    "rtmp ingest",
+    "video origin",
+    "streaming server",
+    "video streaming server",
+    "ffmpeg hls",
+    "mpegts segment"
+  ],
+  "scoring": {
+    "boost": {
+      "hls": 4,
+      "m3u8": 3,
+      "rtmp": 3
+    }
+  },
+  "tieredKeywords": {
+    "tier1": [
+      "hls",
+      "m3u8",
+      "hls origin",
+      "rtmp ingest"
+    ],
+    "tier2": [
+      "live streaming",
+      "rtmp",
+      "video origin",
+      "streaming server",
+      "ffmpeg hls",
+      "mpegts segment"
+    ],
+    "archetypes": [
+      "self-hosted twitch",
+      "live streaming platform",
+      "video cdn origin",
+      "live event streaming",
+      "broadcast server",
+      "multi-bitrate ladder",
+      "abr streaming origin"
+    ]
+  },
+  "buildHints": {
+    "gotchas": [
+      "Segment duration is a latency/stability tradeoff — 2s segments give ~6s glass-to-glass latency with 3-segment buffer; shorter segments drop glass-to-glass at the cost of more frequent playlist churn and higher client buffering risk on flaky networks.",
+      "Browsers require CORS on both the playlist AND every segment. The nginx.conf here adds Access-Control-Allow-Origin to .m3u8 and .ts — stripping either will break HLS.js.",
+      "Safari plays HLS natively; Chrome/Firefox need hls.js. Your frontend must feature-detect: `video.canPlayType('application/vnd.apple.mpegurl')` — non-empty means native, else bundle hls.js.",
+      "ffmpeg's `-hls_flags delete_segments` is mandatory for a rolling window — without it the origin fills disk with every 2s segment ever transcoded.",
+      "RTMP ingest is TCP port 1935, plaintext. Put nginx-rtmp or srtrelay in front if you need auth/TLS; this origin assumes the ingest side is already trusted.",
+      "FFmpeg needs hardware-accelerated codec config (h264_videotoolbox on macOS, h264_nvenc on nvidia) for production-scale transcoding. The default libx264 in start-stream.sh is CPU-bound and single-stream only."
+    ]
+  }
+}

package/registry/families/hugo-static/files/config.toml

@@ -0,0 +1,12 @@
+baseURL = "{{baseURL}}"
+languageCode = "{{languageCode}}"
+title = "{{headline}}"
+
+[params]
+  subtitle = "{{subheadline}}"
+
+[markup.goldmark.renderer]
+  unsafe = true
+
+[server]
+  port = {{port}}

package/registry/families/hugo-static/files/validate-hugo.mjs

@@ -0,0 +1,22 @@
+import { existsSync, readFileSync } from 'node:fs'
+
+const must = (cond, msg) => {
+  if (!cond) {
+    console.error(`validate-hugo: ${msg}`)
+    process.exit(1)
+  }
+}
+
+must(existsSync('config.toml'), 'missing config.toml')
+must(existsSync('content/_index.md'), 'missing content/_index.md home page')
+must(existsSync('layouts/_default/baseof.html'), 'missing layouts/_default/baseof.html')
+must(existsSync('layouts/index.html'), 'missing layouts/index.html')
+
+const cfg = readFileSync('config.toml', 'utf8')
+must(/^baseURL\s*=/m.test(cfg), 'config.toml must set baseURL')
+must(/^title\s*=/m.test(cfg), 'config.toml must set title')
+
+const home = readFileSync('content/_index.md', 'utf8')
+must(/^---[\s\S]+---/m.test(home) || /^\+\+\+[\s\S]+\+\+\+/m.test(home), 'content/_index.md needs YAML or TOML frontmatter')
+
+console.log('hugo starter ok')

package/registry/families/hugo-static/manifest.json

@@ -0,0 +1,99 @@
+{
+  "id": "hugo-static",
+  "description": "Hugo static site generator starter — Go-binary driven, millisecond builds, content bundles under content/ and layouts in Go templates.",
+  "tags": [
+    "hugo",
+    "static-site",
+    "ssg",
+    "frontend",
+    "go-template"
+  ],
+  "taxonomy": {
+    "language": "go-template",
+    "runtime": "hugo",
+    "surface": "frontend"
+  },
+  "defaults": {
+    "projectType": "frontend",
+    "serviceName": "starter-foundry-hugo",
+    "port": 1313,
+    "headline": "Starter Foundry Hugo",
+    "subheadline": "Hugo content site with minimal theme.",
+    "baseURL": "http://localhost:1313/",
+    "languageCode": "en-us",
+    "databaseProvider": "none"
+  },
+  "files": [
+    {
+      "source": "files/config.toml",
+      "target": "config.toml"
+    },
+    {
+      "source": "files/validate-hugo.mjs",
+      "target": "validate-hugo.mjs"
+    }
+  ],
+  "validationChecks": [
+    {
+      "type": "file-exists",
+      "path": "config.toml"
+    },
+    {
+      "type": "file-exists",
+      "path": "content/_index.md"
+    },
+    {
+      "type": "command-success",
+      "command": [
+        "node",
+        "validate-hugo.mjs"
+      ],
+      "expect": "hugo starter ok"
+    }
+  ],
+  "contextHints": {
+    "commands": [
+      "hugo server -D --port {{port}}",
+      "hugo --minify"
+    ],
+    "entrypoints": [
+      "config.toml",
+      "content/_index.md",
+      "layouts/_default/baseof.html"
+    ],
+    "preview": {
+      "port": "{{port}}",
+      "path": "/"
+    },
+    "extensionPoints": [
+      "starter-data.json",
+      "starter-brand.json"
+    ]
+  },
+  "keywords": [
+    "hugo",
+    "hugo site",
+    "hugo blog",
+    "hugo static",
+    "hugo theme",
+    "gohugo"
+  ],
+  "scoring": {
+    "boost": {
+      "hugo": 3,
+      "gohugo": 3
+    }
+  },
+  "tieredKeywords": {
+    "tier1": [
+      "hugo",
+      "hugo site",
+      "hugo blog",
+      "gohugo"
+    ],
+    "tier2": [
+      "hugo static",
+      "hugo theme"
+    ]
+  }
+}

package/registry/families/jupyter-book/files/_config.yml

@@ -0,0 +1,26 @@
+title: "{{headline}}"
+author: "{{author}}"
+copyright: ""
+logo: ""
+
+execute:
+  execute_notebooks: auto
+
+parse:
+  myst_enable_extensions:
+    - colon_fence
+    - dollarmath
+    - linkify
+    - substitution
+
+html:
+  use_issues_button: false
+  use_repository_button: false
+
+latex:
+  latex_documents:
+    targetname: book.tex
+
+sphinx:
+  config:
+    html_title: "{{headline}}"

package/registry/families/jupyter-book/files/_toc.yml

@@ -0,0 +1,4 @@
+format: jb-book
+root: content/intro
+chapters:
+  - file: content/chapter-1

package/registry/families/jupyter-book/files/intro.md

@@ -0,0 +1,16 @@
+# {{headline}}
+
+{{subheadline}}
+
+This book is built with [Jupyter Book](https://jupyterbook.org/). Edit
+`_toc.yml` to add chapters, and drop Markdown or `.ipynb` notebooks under
+`content/`.
+
+## Build
+
+```
+pip install -r requirements.txt
+jupyter-book build .
+```
+
+The static site lands in `_build/html/`.

package/registry/families/jupyter-book/files/requirements.txt

@@ -0,0 +1,3 @@
+jupyter-book>=1.0.0
+matplotlib>=3.8
+numpy>=1.26

package/registry/families/jupyter-book/files/validate-jupyter-book.mjs

@@ -0,0 +1,26 @@
+import { existsSync, readFileSync } from 'node:fs'
+
+const must = (cond, msg) => {
+  if (!cond) {
+    console.error(`validate-jupyter-book: ${msg}`)
+    process.exit(1)
+  }
+}
+
+must(existsSync('_config.yml'), 'missing _config.yml')
+must(existsSync('_toc.yml'), 'missing _toc.yml')
+must(existsSync('content/intro.md'), 'missing content/intro.md')
+must(existsSync('content/chapter-1.md'), 'missing content/chapter-1.md')
+must(existsSync('requirements.txt'), 'missing requirements.txt')
+
+const cfg = readFileSync('_config.yml', 'utf8')
+must(/^title:/m.test(cfg), '_config.yml must set title')
+
+const toc = readFileSync('_toc.yml', 'utf8')
+must(/^format:\s*jb-book/m.test(toc), '_toc.yml must declare format: jb-book')
+must(/^root:/m.test(toc), '_toc.yml must set root')
+
+const reqs = readFileSync('requirements.txt', 'utf8')
+must(/jupyter-book/.test(reqs), 'requirements.txt must pin jupyter-book')
+
+console.log('jupyter-book starter ok')

package/registry/families/jupyter-book/manifest.json

@@ -0,0 +1,115 @@
+{
+  "id": "jupyter-book",
+  "description": "Jupyter Book starter — publish executable Markdown and notebooks as a multi-page book with MyST, executed by Sphinx under the hood.",
+  "tags": [
+    "jupyter-book",
+    "jupyter",
+    "documentation",
+    "scientific",
+    "python"
+  ],
+  "taxonomy": {
+    "language": "python",
+    "runtime": "python",
+    "surface": "docs"
+  },
+  "defaults": {
+    "projectType": "docs",
+    "serviceName": "starter-foundry-jbook",
+    "port": 8098,
+    "headline": "Starter Foundry Jupyter Book",
+    "subheadline": "Executable scientific book built with Jupyter Book and MyST.",
+    "author": "Starter Foundry"
+  },
+  "files": [
+    {
+      "source": "files/_config.yml",
+      "target": "_config.yml"
+    },
+    {
+      "source": "files/_toc.yml",
+      "target": "_toc.yml"
+    },
+    {
+      "source": "files/requirements.txt",
+      "target": "requirements.txt"
+    },
+    {
+      "source": "files/intro.md",
+      "target": "content/intro.md"
+    },
+    {
+      "source": "files/validate-jupyter-book.mjs",
+      "target": "validate-jupyter-book.mjs"
+    }
+  ],
+  "validationChecks": [
+    {
+      "type": "file-exists",
+      "path": "_config.yml"
+    },
+    {
+      "type": "file-exists",
+      "path": "_toc.yml"
+    },
+    {
+      "type": "file-exists",
+      "path": "content/intro.md"
+    },
+    {
+      "type": "command-success",
+      "command": [
+        "node",
+        "validate-jupyter-book.mjs"
+      ],
+      "expect": "jupyter-book starter ok"
+    }
+  ],
+  "contextHints": {
+    "commands": [
+      "pip install -r requirements.txt",
+      "jupyter-book build .",
+      "python -m http.server --directory _build/html {{port}}"
+    ],
+    "entrypoints": [
+      "_config.yml",
+      "_toc.yml",
+      "content/intro.md"
+    ],
+    "preview": {
+      "port": "{{port}}",
+      "path": "/"
+    },
+    "extensionPoints": [
+      "starter-data.json"
+    ]
+  },
+  "keywords": [
+    "jupyter book",
+    "jupyter-book",
+    "executable book",
+    "myst markdown",
+    "scientific documentation",
+    "notebook book",
+    "computational narrative"
+  ],
+  "scoring": {
+    "boost": {
+      "jupyter-book": 3,
+      "jupyter book": 3
+    }
+  },
+  "tieredKeywords": {
+    "tier1": [
+      "jupyter book",
+      "jupyter-book",
+      "executable book",
+      "computational narrative"
+    ],
+    "tier2": [
+      "myst markdown",
+      "scientific documentation",
+      "notebook book"
+    ]
+  }
+}

package/registry/families/k12-edtech/files/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "{{packageName}}",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "node --watch --experimental-strip-types src/server.ts",
+    "start": "node --experimental-strip-types src/server.ts",
+    "validate": "node validate-k12.mjs",
+    "db:generate": "drizzle-kit generate",
+    "db:migrate": "drizzle-kit migrate"
+  },
+  "dependencies": {
+    "drizzle-orm": "^0.36.0",
+    "postgres": "^3.4.5"
+  },
+  "devDependencies": {
+    "drizzle-kit": "^0.30.0",
+    "typescript": "^5.9.0",
+    "@types/node": "^20.17.0"
+  },
+  "overrides": { "vite": "^6.4.2" },
+  "pnpm": { "overrides": { "vite": "^6.4.2" } }
+}

package/registry/families/k12-edtech/files/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "noEmit": true
+  },
+  "include": ["src/**/*.ts"]
+}

package/registry/families/k12-edtech/files/validate-k12.mjs

@@ -0,0 +1,28 @@
+import fs from "node:fs/promises";
+import { stripTypeScriptTypes } from "node:module";
+
+const paths = [
+  "src/server.ts",
+  "src/db/schema.ts",
+  "src/api/classroom.ts",
+  "src/api/gradebook.ts",
+];
+const sources = await Promise.all(paths.map((p) => fs.readFile(p, "utf8")));
+for (const s of sources) stripTypeScriptTypes(s);
+const [server, schema, classroom, gradebook] = sources;
+
+const required = ["students", "teachers", "classes", "assignments", "submissions", "grades", "parents"];
+for (const t of required) {
+  if (!schema.includes(t)) throw new Error(`schema.ts missing table: ${t}`);
+}
+
+if (!gradebook.includes("auditLog") && !gradebook.includes("audit_log") && !gradebook.includes("gradeAccess")) {
+  throw new Error("gradebook.ts must write an audit-log row on grade reads (FERPA)");
+}
+
+if (!server.includes('/health')) {
+  throw new Error("server.ts missing /health route");
+}
+
+JSON.parse(await fs.readFile("package.json", "utf8"));
+console.log("k12 starter ok");

package/registry/families/k12-edtech/manifest.json

@@ -0,0 +1,64 @@
+{
+  "id": "k12-edtech",
+  "description": "K-12 SIS / gradebook API — students, teachers, classes, assignments, submissions, grades, parent relations, FERPA-aligned audit trail on grade reads.",
+  "tags": ["k-12", "edtech", "api", "typescript"],
+  "taxonomy": {
+    "language": "typescript",
+    "runtime": "node",
+    "surface": "api"
+  },
+  "slots": {
+    "database": { "options": ["database:sqlite", "database:postgres"], "default": "database:postgres" },
+    "auth": { "options": ["auth:none", "auth:better-auth", "auth:clerk"], "default": "auth:clerk" }
+  },
+  "defaults": {
+    "projectType": "api",
+    "serviceName": "starter-foundry-k12",
+    "port": 8103,
+    "databaseProvider": "postgres"
+  },
+  "files": [
+    { "source": "files/package.json", "target": "package.json" },
+    { "source": "files/tsconfig.json", "target": "tsconfig.json" },
+    { "source": "files/validate-k12.mjs", "target": "validate-k12.mjs" }
+  ],
+  "validationChecks": [
+    { "type": "file-exists", "path": "src/server.ts" },
+    { "type": "file-exists", "path": "src/db/schema.ts" },
+    { "type": "file-exists", "path": "src/api/classroom.ts" },
+    { "type": "file-exists", "path": "src/api/gradebook.ts" },
+    { "type": "command-success", "command": ["node", "validate-k12.mjs"], "expect": "k12 starter ok" }
+  ],
+  "contextHints": {
+    "commands": ["pnpm install", "pnpm dev", "pnpm drizzle-kit generate", "pnpm drizzle-kit migrate"],
+    "entrypoints": ["src/server.ts", "src/db/schema.ts", "src/api/classroom.ts", "src/api/gradebook.ts"],
+    "preview": { "path": "/health" },
+    "extensionPoints": ["src/db/schema.ts", "src/api/"]
+  },
+  "keywords": [
+    "k-12",
+    "k12",
+    "edtech",
+    "ed tech",
+    "classroom management",
+    "gradebook",
+    "student information system",
+    "sis",
+    "school software",
+    "lms backend",
+    "learning management"
+  ],
+  "scoring": { "boost": { "k-12": 4, "edtech": 3, "gradebook": 4 } },
+  "tieredKeywords": {
+    "tier1": [
+      "k-12",
+      "k12",
+      "edtech",
+      "classroom management",
+      "gradebook",
+      "student information system",
+      "sis"
+    ],
+    "tier2": ["school software", "lms backend", "learning management", "ferpa"]
+  }
+}