create-vizcraft-playground 0.1.0

package/template/scripts/init-playground.js

@@ -0,0 +1,119 @@
+import fs from "fs";
+import path from "path";
+import readline from "readline";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const root = path.join(__dirname, "..");
+
+// ── Readline helpers ───────────────────────────────────────
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+const ask = (question, fallback) =>
+  new Promise((resolve) => {
+    const suffix = fallback ? ` (${fallback}): ` : ": ";
+    rl.question(question + suffix, (answer) => {
+      resolve(answer.trim() || fallback || "");
+    });
+  });
+
+// ── Helpers ────────────────────────────────────────────────
+const toSlug = (str) =>
+  str
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/(^-|-$)/g, "");
+
+// ── Main ───────────────────────────────────────────────────
+async function main() {
+  console.log("");
+  console.log("╔═══════════════════════════════════════════════╗");
+  console.log("║       VizCraft Playground — Init Wizard       ║");
+  console.log("╚═══════════════════════════════════════════════╝");
+  console.log("");
+  console.log("  Configure your playground branding.");
+  console.log("");
+
+  const title = await ask("  Playground title", "My Playground");
+  const subtitle = await ask(
+    "  Subtitle (one-liner for the landing page)",
+    "Explore interactive visualizations.",
+  );
+  const accent = await ask("  Primary accent colour (hex)", "#3b82f6");
+  const slug = toSlug(title);
+
+  console.log("");
+
+  // ── 1. Write playground.config.ts ──────────────────────
+  const configPath = path.join(root, "src/playground.config.ts");
+  const configContent = `/* ═══════════════════════════════════════════════════════
+ *  Playground Configuration
+ *
+ *  Single source of truth for branding & metadata.
+ *  Run \`npm run init\` to regenerate this file interactively,
+ *  or edit the values below directly.
+ * ═══════════════════════════════════════════════════════ */
+
+export interface PlaygroundConfig {
+  /** Project slug (kebab-case), used in package.json name */
+  name: string;
+  /** Display title shown on the landing page */
+  title: string;
+  /** One-liner shown below the title on the landing page */
+  subtitle: string;
+  /** Primary accent colour (hex) */
+  accent: string;
+}
+
+const playgroundConfig: PlaygroundConfig = {
+  name: "${slug}",
+  title: "${title.replace(/"/g, '\\"')}",
+  subtitle:
+    "${subtitle.replace(/"/g, '\\"')}",
+  accent: "${accent}",
+};
+
+export default playgroundConfig;
+`;
+  fs.writeFileSync(configPath, configContent);
+  console.log("  ✔ src/playground.config.ts");
+
+  // ── 2. Update package.json name ────────────────────────
+  const pkgPath = path.join(root, "package.json");
+  const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+  pkg.name = slug;
+  fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
+  console.log("  ✔ package.json  (name → " + slug + ")");
+
+  // ── 3. Update index.html <title> ──────────────────────
+  const htmlPath = path.join(root, "index.html");
+  let html = fs.readFileSync(htmlPath, "utf-8");
+  html = html.replace(/<title>.*<\/title>/, "<title>" + title + "</title>");
+  fs.writeFileSync(htmlPath, html);
+  console.log("  ✔ index.html  (title → " + title + ")");
+
+  // ── 4. Update README headline + subtitle ───────────────
+  const readmePath = path.join(root, "README.md");
+  if (fs.existsSync(readmePath)) {
+    let readme = fs.readFileSync(readmePath, "utf-8");
+    readme = readme.replace(/^# .*$/m, "# " + title);
+    fs.writeFileSync(readmePath, readme);
+    console.log("  ✔ README.md");
+  }
+
+  console.log("");
+  console.log("  All done! Run `npm run dev` to start.");
+  console.log("");
+
+  rl.close();
+}
+
+main().catch((err) => {
+  console.error(err);
+  rl.close();
+  process.exit(1);
+});

package/template/src/App.scss

@@ -0,0 +1,137 @@
+.app {
+  width: 100%;
+  height: 100vh;
+  margin: 0;
+  padding: 0;
+  box-sizing: border-box;
+  overflow: hidden;
+
+  display: flex;
+  flex-direction: column;
+
+  /* dark slate */
+  color: #e5e7eb;
+  /* light gray */
+  font-family:
+    system-ui,
+    -apple-system,
+    BlinkMacSystemFont,
+    "Segoe UI",
+    sans-serif;
+  background-color: #111827; // Gray-900
+}
+
+.app-header {
+  padding: 1rem 2rem;
+  background-color: #1f2937; // Gray-800
+  border-bottom: 1px solid #374151; // Gray-700
+  flex-shrink: 0;
+
+  h1 {
+    margin: 0;
+    font-size: 1.5rem;
+    color: #f3f4f6;
+  }
+
+  p {
+    margin: 0.25rem 0 0;
+    color: #9ca3af;
+    font-size: 0.875rem;
+  }
+
+  &__nav {
+    display: flex;
+    align-items: center;
+    gap: 1rem;
+  }
+
+  &__back {
+    background: none;
+    border: 1px solid #475569;
+    color: #e2e8f0;
+    font-size: 1.1rem;
+    width: 36px;
+    height: 36px;
+    border-radius: 8px;
+    cursor: pointer;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    flex-shrink: 0;
+    transition:
+      background 0.15s,
+      border-color 0.15s;
+    padding: 0;
+
+    &:hover {
+      background: #334155;
+      border-color: #64748b;
+    }
+  }
+
+  &__text {
+    min-width: 0;
+  }
+
+  &__breadcrumb {
+    display: flex;
+    align-items: center;
+    gap: 0.5rem;
+    font-size: 1.25rem;
+    font-weight: 600;
+    color: #f3f4f6;
+    flex-wrap: wrap;
+  }
+
+  &__sep {
+    color: #475569;
+    font-weight: 400;
+  }
+
+  &__plugin-name {
+    color: #e2e8f0;
+  }
+
+  &__category {
+    font-weight: 500;
+  }
+
+  &__select {
+    background: #0f172a;
+    color: #e2e8f0;
+    border: 1px solid #475569;
+    border-radius: 6px;
+    padding: 0.25rem 0.5rem;
+    font-size: 1rem;
+    font-weight: 600;
+    cursor: pointer;
+
+    &:hover {
+      border-color: #64748b;
+    }
+
+    &:focus {
+      outline: none;
+      border-color: #818cf8;
+    }
+  }
+}
+
+.main-content {
+  flex: 1;
+  display: flex;
+  flex-direction: row;
+  overflow: hidden;
+  position: relative;
+}
+
+.visualization-container {
+  flex: 1;
+  position: relative;
+  overflow: hidden;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  padding: 2rem;
+  background-color: #111827; // Gray-900
+}

package/template/src/App.tsx

@@ -0,0 +1,72 @@
+import { BrowserRouter, Routes, Route, Navigate } from "react-router-dom";
+import "./App.scss";
+import Shell from "./components/Shell";
+import Landing from "./components/Landing/Landing";
+import { categories, findCategory, findPlugin } from "./registry";
+
+/**
+ * Wrapper that resolves /:categoryId/:pluginId params and
+ * feeds the matching plugin into Shell.
+ */
+function PluginRoute() {
+  // react-router doesn't expose useParams without a generic, so grab from URL
+  const [, categoryId, pluginId] = window.location.pathname.split("/");
+
+  const category = findCategory(categoryId);
+  const plugin = findPlugin(pluginId);
+
+  if (!category || !plugin) {
+    return <Navigate to="/" replace />;
+  }
+
+  return <Shell plugin={plugin} category={category} />;
+}
+
+/**
+ * Redirect bare category URLs (e.g. /system-design) to the first plugin
+ * inside that category.
+ */
+function CategoryRedirect() {
+  const [, categoryId] = window.location.pathname.split("/");
+  const category = findCategory(categoryId);
+
+  if (!category || category.plugins.length === 0) {
+    return <Navigate to="/" replace />;
+  }
+
+  return <Navigate to={`/${category.id}/${category.plugins[0].id}`} replace />;
+}
+
+function App() {
+  // Build one Route per category (for bare-category redirects)
+  // and one per category/plugin pair.
+  return (
+    <BrowserRouter>
+      <Routes>
+        <Route path="/" element={<Landing />} />
+
+        {categories.map((cat) => (
+          <Route
+            key={cat.id}
+            path={`/${cat.id}`}
+            element={<CategoryRedirect />}
+          />
+        ))}
+
+        {categories.flatMap((cat) =>
+          cat.plugins.map((p) => (
+            <Route
+              key={`${cat.id}/${p.id}`}
+              path={`/${cat.id}/${p.id}`}
+              element={<PluginRoute />}
+            />
+          )),
+        )}
+
+        <Route path="*" element={<Navigate to="/" replace />} />
+      </Routes>
+    </BrowserRouter>
+  );
+}
+
+export default App;

package/template/src/assets/react.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>

package/template/src/components/InfoModal/InfoModal.scss

@@ -0,0 +1,211 @@
+.info-modal-backdrop {
+  position: fixed;
+  inset: 0;
+  background: rgba(0, 0, 0, 0.72);
+  backdrop-filter: blur(4px);
+  z-index: 100;
+  animation: fadeIn 0.18s ease-out;
+}
+
+.info-modal {
+  --accent: #60a5fa;
+
+  position: fixed;
+  top: 50%;
+  left: 50%;
+  transform: translate(-50%, -50%);
+  width: min(88vw, 860px);
+  max-height: 82vh;
+  background: #1e293b;
+  border-radius: 16px;
+  box-shadow:
+    0 30px 60px -12px rgba(0, 0, 0, 0.55),
+    0 0 0 1px rgba(255, 255, 255, 0.06);
+  display: flex;
+  flex-direction: column;
+  overflow: hidden;
+  z-index: 101;
+  border: 1px solid #334155;
+  animation: modalSlideIn 0.22s ease-out;
+
+  &__header {
+    padding: 1.25rem 1.5rem;
+    background: #0f172a;
+    border-bottom: 1px solid #334155;
+    display: flex;
+    justify-content: space-between;
+    align-items: flex-start;
+    gap: 1rem;
+    flex-shrink: 0;
+  }
+
+  &__title {
+    margin: 0;
+    color: #f1f5f9;
+    font-size: 1.35rem;
+    font-weight: 700;
+    letter-spacing: -0.01em;
+  }
+
+  &__subtitle {
+    margin: 0.3rem 0 0;
+    color: #94a3b8;
+    font-size: 0.82rem;
+  }
+
+  &__close {
+    background: transparent;
+    border: none;
+    color: #64748b;
+    font-size: 1.6rem;
+    line-height: 1;
+    cursor: pointer;
+    padding: 0.35rem 0.5rem;
+    border-radius: 8px;
+    transition: all 0.15s;
+    flex-shrink: 0;
+
+    &:hover {
+      background: #334155;
+      color: #f1f5f9;
+    }
+  }
+
+  &__body {
+    flex: 1;
+    display: flex;
+    gap: 1.5rem;
+    padding: 1.5rem;
+    overflow-y: auto;
+
+    // Custom scrollbar
+    &::-webkit-scrollbar {
+      width: 6px;
+    }
+    &::-webkit-scrollbar-track {
+      background: transparent;
+    }
+    &::-webkit-scrollbar-thumb {
+      background: #334155;
+      border-radius: 3px;
+    }
+  }
+
+  &__sections {
+    flex: 1;
+    display: flex;
+    flex-direction: column;
+    gap: 1rem;
+    min-width: 0;
+  }
+
+  &__section {
+    --section-accent: var(--accent);
+    background: #0f172a;
+    border-radius: 12px;
+    border: 1px solid #1e293b;
+    border-left: 3px solid var(--section-accent);
+    padding: 1.1rem 1.25rem;
+    transition: border-color 0.15s;
+  }
+
+  &__section-title {
+    margin: 0 0 0.6rem;
+    color: var(--section-accent);
+    font-size: 0.95rem;
+    font-weight: 600;
+    letter-spacing: 0.01em;
+  }
+
+  &__section-content {
+    color: #cbd5e1;
+    font-size: 0.85rem;
+    line-height: 1.65;
+
+    p {
+      margin: 0 0 0.5rem;
+      &:last-child {
+        margin-bottom: 0;
+      }
+    }
+
+    strong {
+      color: #e2e8f0;
+      font-weight: 600;
+    }
+
+    code {
+      background: #1e293b;
+      color: #fbbf24;
+      padding: 0.15em 0.4em;
+      border-radius: 4px;
+      font-size: 0.9em;
+      font-family: "SF Mono", "Fira Code", monospace;
+    }
+
+    ul {
+      margin: 0.4rem 0;
+      padding-left: 1.2rem;
+
+      li {
+        margin-bottom: 0.3rem;
+      }
+    }
+  }
+
+  &__aside {
+    flex: 0 0 220px;
+    background: #0f172a;
+    border-radius: 12px;
+    border: 1px solid #1e293b;
+    padding: 1.1rem;
+    color: #94a3b8;
+    font-size: 0.8rem;
+    line-height: 1.6;
+    align-self: flex-start;
+
+    h4 {
+      margin: 0 0 0.6rem;
+      color: #e2e8f0;
+      font-size: 0.85rem;
+    }
+  }
+}
+
+@keyframes fadeIn {
+  from {
+    opacity: 0;
+  }
+  to {
+    opacity: 1;
+  }
+}
+
+@keyframes modalSlideIn {
+  from {
+    opacity: 0;
+    transform: translate(-50%, -48%);
+  }
+  to {
+    opacity: 1;
+    transform: translate(-50%, -50%);
+  }
+}
+
+// Responsive
+@media (max-width: 700px) {
+  .info-modal {
+    width: 96vw;
+    max-height: 90vh;
+
+    &__body {
+      flex-direction: column;
+      padding: 1rem;
+    }
+
+    &__aside {
+      flex: none;
+      width: 100%;
+    }
+  }
+}

package/template/src/components/InfoModal/InfoModal.tsx

@@ -0,0 +1,85 @@
+import React, { useEffect } from "react";
+import "./InfoModal.scss";
+
+export interface InfoModalSection {
+  title: string;
+  content: React.ReactNode;
+  accent?: string;
+}
+
+export interface InfoModalProps {
+  isOpen: boolean;
+  onClose: () => void;
+  title: string;
+  subtitle?: string;
+  accentColor?: string;
+  sections: InfoModalSection[];
+  aside?: React.ReactNode;
+}
+
+const InfoModal: React.FC<InfoModalProps> = ({
+  isOpen,
+  onClose,
+  title,
+  subtitle,
+  accentColor = "#60a5fa",
+  sections,
+  aside,
+}) => {
+  useEffect(() => {
+    if (!isOpen) return;
+    const handler = (e: KeyboardEvent) => {
+      if (e.key === "Escape") onClose();
+    };
+    window.addEventListener("keydown", handler);
+    return () => window.removeEventListener("keydown", handler);
+  }, [isOpen, onClose]);
+
+  if (!isOpen) return null;
+
+  return (
+    <>
+      <div className="info-modal-backdrop" onClick={onClose} />
+      <div
+        className="info-modal"
+        style={{ "--accent": accentColor } as React.CSSProperties}
+      >
+        <div className="info-modal__header">
+          <div>
+            <h2 className="info-modal__title">{title}</h2>
+            {subtitle && <p className="info-modal__subtitle">{subtitle}</p>}
+          </div>
+          <button className="info-modal__close" onClick={onClose}>
+            &times;
+          </button>
+        </div>
+
+        <div className="info-modal__body">
+          <div className="info-modal__sections">
+            {sections.map((section, i) => (
+              <div
+                key={i}
+                className="info-modal__section"
+                style={
+                  section.accent
+                    ? ({
+                        "--section-accent": section.accent,
+                      } as React.CSSProperties)
+                    : undefined
+                }
+              >
+                <h3 className="info-modal__section-title">{section.title}</h3>
+                <div className="info-modal__section-content">
+                  {section.content}
+                </div>
+              </div>
+            ))}
+          </div>
+          {aside && <div className="info-modal__aside">{aside}</div>}
+        </div>
+      </div>
+    </>
+  );
+};
+
+export default InfoModal;