create-goodfellow 0.0.0-stage → 0.2.0

package/templates/starter/content/layout/header.json

@@ -0,0 +1,54 @@
+{
+  "version": 1,
+  "data": {
+    "content": [
+      {
+        "type": "Section",
+        "props": {
+          "id": "Section-header",
+          "background": "none",
+          "backgroundImage": "",
+          "className": "",
+          "content": [
+            {
+              "type": "Flex",
+              "props": {
+                "id": "Flex-header",
+                "align": "center",
+                "className": "",
+                "direction": "row",
+                "gap": "md",
+                "items": [
+                  {
+                    "type": "SiteBrand",
+                    "props": {
+                      "id": "SiteBrand-header",
+                      "className": "",
+                      "show": "both"
+                    }
+                  },
+                  {
+                    "type": "Menu",
+                    "props": {
+                      "id": "Menu-main",
+                      "className": "",
+                      "menu": "main",
+                      "orientation": "horizontal"
+                    }
+                  }
+                ],
+                "justify": "between",
+                "wrap": true
+              }
+            }
+          ],
+          "padding": "sm",
+          "width": "wide"
+        }
+      }
+    ],
+    "root": {
+      "props": {}
+    }
+  }
+}

package/templates/starter/content/menus.json

@@ -0,0 +1,25 @@
+{
+  "version": 1,
+  "menus": {
+    "footer": [
+      {
+        "href": "/about",
+        "label": "About"
+      }
+    ],
+    "main": [
+      {
+        "href": "/",
+        "label": "Home"
+      },
+      {
+        "href": "/about",
+        "label": "About"
+      },
+      {
+        "href": "/news",
+        "label": "News"
+      }
+    ]
+  }
+}

package/templates/starter/content/pages/404.json

@@ -0,0 +1,73 @@
+{
+  "version": 1,
+  "data": {
+    "content": [
+      {
+        "type": "Section",
+        "props": {
+          "id": "Section-not-found",
+          "background": "none",
+          "backgroundImage": "",
+          "className": "",
+          "content": [
+            {
+              "type": "Heading",
+              "props": {
+                "id": "Heading-not-found",
+                "align": "center",
+                "className": "",
+                "level": "h1",
+                "text": "Page not found"
+              }
+            },
+            {
+              "type": "Text",
+              "props": {
+                "id": "Text-not-found",
+                "align": "center",
+                "className": "mt-4 text-muted-foreground",
+                "content": "<p>The page you're looking for doesn't exist or has moved.</p>"
+              }
+            },
+            {
+              "type": "Flex",
+              "props": {
+                "id": "Flex-not-found",
+                "align": "center",
+                "className": "mt-8",
+                "direction": "row",
+                "gap": "md",
+                "items": [
+                  {
+                    "type": "Button",
+                    "props": {
+                      "id": "Button-home",
+                      "className": "",
+                      "href": "/",
+                      "label": "Go to the home page",
+                      "newTab": false,
+                      "size": "md",
+                      "variant": "primary"
+                    }
+                  }
+                ],
+                "justify": "center",
+                "wrap": true
+              }
+            }
+          ],
+          "padding": "lg",
+          "width": "narrow"
+        }
+      }
+    ],
+    "root": {
+      "props": {
+        "className": "",
+        "description": "",
+        "image": "",
+        "title": "Page not found"
+      }
+    }
+  }
+}

package/templates/starter/content/pages/about.json

@@ -0,0 +1,59 @@
+{
+  "version": 1,
+  "data": {
+    "content": [
+      {
+        "type": "Section",
+        "props": {
+          "id": "Section-about",
+          "background": "none",
+          "backgroundImage": "",
+          "className": "",
+          "content": [
+            {
+              "type": "Heading",
+              "props": {
+                "id": "Heading-about",
+                "align": "left",
+                "className": "",
+                "level": "h1",
+                "text": "About us"
+              }
+            },
+            {
+              "type": "Text",
+              "props": {
+                "id": "Text-about",
+                "align": "left",
+                "className": "mt-6",
+                "content": "<p>Tell visitors who you are. This text supports <strong>bold</strong>, <em>italics</em>, lists and <a href=\"/\">links</a>.</p><ul><li>Founded in 2026</li><li>Based wherever you are</li></ul>"
+              }
+            },
+            {
+              "type": "Image",
+              "props": {
+                "id": "Image-about",
+                "alt": "",
+                "aspect": "wide",
+                "caption": "Replace this image with one of your own.",
+                "className": "mt-8",
+                "rounded": true,
+                "src": "/media/placeholder.svg"
+              }
+            }
+          ],
+          "padding": "lg",
+          "width": "narrow"
+        }
+      }
+    ],
+    "root": {
+      "props": {
+        "className": "",
+        "description": "Who we are and what we do.",
+        "image": "",
+        "title": "About us"
+      }
+    }
+  }
+}

package/templates/starter/content/pages/index.json

@@ -0,0 +1,215 @@
+{
+  "version": 1,
+  "data": {
+    "content": [
+      {
+        "type": "Section",
+        "props": {
+          "id": "Section-hero",
+          "background": "primary",
+          "backgroundImage": "",
+          "className": "",
+          "content": [
+            {
+              "type": "Heading",
+              "props": {
+                "id": "Heading-hero",
+                "align": "left",
+                "className": "",
+                "level": "h1",
+                "text": "Welcome to my site"
+              }
+            },
+            {
+              "type": "Text",
+              "props": {
+                "id": "Text-hero",
+                "align": "left",
+                "className": "mt-4 max-w-2xl text-lg opacity-90",
+                "content": "<p>This page is stored as a file in your site's repository. Edit it in the admin panel, or change <code>content/pages/index.json</code> directly.</p>"
+              }
+            },
+            {
+              "type": "Flex",
+              "props": {
+                "id": "Flex-hero",
+                "align": "center",
+                "className": "mt-8",
+                "direction": "row",
+                "gap": "md",
+                "items": [
+                  {
+                    "type": "Button",
+                    "props": {
+                      "id": "Button-primary",
+                      "className": "",
+                      "href": "/about",
+                      "label": "About us",
+                      "newTab": false,
+                      "size": "lg",
+                      "variant": "secondary"
+                    }
+                  },
+                  {
+                    "type": "Button",
+                    "props": {
+                      "id": "Button-secondary",
+                      "className": "",
+                      "href": "/about",
+                      "label": "Contact",
+                      "newTab": false,
+                      "size": "lg",
+                      "variant": "outline"
+                    }
+                  }
+                ],
+                "justify": "start",
+                "wrap": true
+              }
+            }
+          ],
+          "padding": "lg",
+          "width": "normal"
+        }
+      },
+      {
+        "type": "Section",
+        "props": {
+          "id": "Section-features",
+          "background": "none",
+          "backgroundImage": "",
+          "className": "",
+          "content": [
+            {
+              "type": "Heading",
+              "props": {
+                "id": "Heading-features",
+                "align": "center",
+                "className": "mb-10",
+                "level": "h2",
+                "text": "Everything in one place"
+              }
+            },
+            {
+              "type": "Grid",
+              "props": {
+                "id": "Grid-features",
+                "className": "",
+                "columns": "3",
+                "gap": "md",
+                "items": [
+                  {
+                    "type": "Section",
+                    "props": {
+                      "id": "Section-feature-1",
+                      "background": "none",
+                      "backgroundImage": "",
+                      "className": "rounded-lg border px-2 py-6",
+                      "content": [
+                        {
+                          "type": "Heading",
+                          "props": {
+                            "id": "Heading-feature-1",
+                            "align": "left",
+                            "className": "",
+                            "level": "h3",
+                            "text": "Pages"
+                          }
+                        },
+                        {
+                          "type": "Text",
+                          "props": {
+                            "id": "Text-feature-1",
+                            "align": "left",
+                            "className": "mt-2 text-muted-foreground",
+                            "content": "<p>Build pages from blocks: sections, columns, text, images and buttons.</p>"
+                          }
+                        }
+                      ],
+                      "padding": "none",
+                      "width": "full"
+                    }
+                  },
+                  {
+                    "type": "Section",
+                    "props": {
+                      "id": "Section-feature-2",
+                      "background": "none",
+                      "backgroundImage": "",
+                      "className": "rounded-lg border px-2 py-6",
+                      "content": [
+                        {
+                          "type": "Heading",
+                          "props": {
+                            "id": "Heading-feature-2",
+                            "align": "left",
+                            "className": "",
+                            "level": "h3",
+                            "text": "Your design"
+                          }
+                        },
+                        {
+                          "type": "Text",
+                          "props": {
+                            "id": "Text-feature-2",
+                            "align": "left",
+                            "className": "mt-2 text-muted-foreground",
+                            "content": "<p>Set colors and fonts once in the site settings, and every page follows.</p>"
+                          }
+                        }
+                      ],
+                      "padding": "none",
+                      "width": "full"
+                    }
+                  },
+                  {
+                    "type": "Section",
+                    "props": {
+                      "id": "Section-feature-3",
+                      "background": "none",
+                      "backgroundImage": "",
+                      "className": "rounded-lg border px-2 py-6",
+                      "content": [
+                        {
+                          "type": "Heading",
+                          "props": {
+                            "id": "Heading-feature-3",
+                            "align": "left",
+                            "className": "",
+                            "level": "h3",
+                            "text": "No hosting bills"
+                          }
+                        },
+                        {
+                          "type": "Text",
+                          "props": {
+                            "id": "Text-feature-3",
+                            "align": "left",
+                            "className": "mt-2 text-muted-foreground",
+                            "content": "<p>The whole site is static files, so free hosting is enough.</p>"
+                          }
+                        }
+                      ],
+                      "padding": "none",
+                      "width": "full"
+                    }
+                  }
+                ]
+              }
+            }
+          ],
+          "padding": "lg",
+          "width": "normal"
+        }
+      }
+    ],
+    "root": {
+      "props": {
+        "className": "",
+        "description": "",
+        "image": "",
+        "title": "Welcome"
+      }
+    }
+  }
+}

package/templates/starter/content/pages/news.json

@@ -0,0 +1,55 @@
+{
+  "version": 1,
+  "data": {
+    "content": [
+      {
+        "type": "Section",
+        "props": {
+          "id": "Section-news-list",
+          "background": "none",
+          "backgroundImage": "",
+          "className": "",
+          "content": [
+            {
+              "type": "Heading",
+              "props": {
+                "id": "Heading-news",
+                "align": "left",
+                "className": "",
+                "level": "h1",
+                "text": "News"
+              }
+            },
+            {
+              "type": "CollectionList",
+              "props": {
+                "id": "CollectionList-news",
+                "className": "mt-8",
+                "collection": "news",
+                "columns": "3",
+                "dateField": "date",
+                "emptyText": "No news yet.",
+                "imageField": "image",
+                "layout": "cards",
+                "limit": 0,
+                "order": "default",
+                "show": "all",
+                "summaryField": "summary"
+              }
+            }
+          ],
+          "padding": "lg",
+          "width": "normal"
+        }
+      }
+    ],
+    "root": {
+      "props": {
+        "className": "",
+        "description": "The latest news.",
+        "image": "",
+        "title": "News"
+      }
+    }
+  }
+}

package/templates/starter/content/site.json

@@ -0,0 +1,25 @@
+{
+  "version": 1,
+  "description": "A website built with Goodfellow.",
+  "favicon": "/media/favicon.svg",
+  "language": "en",
+  "logo": {
+    "alt": "My site",
+    "src": "/media/logo.svg"
+  },
+  "theme": {
+    "colors": {
+      "border": "#e2e8f0",
+      "muted": "#f1f5f9",
+      "mutedForeground": "#64748b",
+      "primary": "#1e3a8a",
+      "primaryForeground": "#ffffff"
+    },
+    "fonts": {
+      "body": "Inter",
+      "heading": "Fraunces"
+    }
+  },
+  "title": "My site",
+  "titleTemplate": "%s | My site"
+}

package/templates/starter/content/styles/custom.css

@@ -0,0 +1,4 @@
+/* Site-wide CSS. Anything here overrides the blocks' own styles. */
+.gf-header {
+  border-bottom: 1px solid var(--color-border);
+}

package/templates/starter/goodfellow.config.tsx

@@ -0,0 +1,17 @@
+import { blocks, categories } from "@goodfellow-cms/blocks";
+import { defineConfig } from "@goodfellow-cms/core";
+// import { github } from "@goodfellow-cms/github";
+// import { gitlab } from "@goodfellow-cms/gitlab";
+import { installedBlocks, installedCategories } from "./blocks/installed";
+
+export default defineConfig({
+  // The built-in blocks, and those installed from the admin panel's Blocks screen.
+  // Add your own here too, e.g. `blocks: { ...blocks, ...installedBlocks, MassTimes }`.
+  blocks: { ...blocks, ...installedBlocks },
+  categories: { ...categories, ...installedCategories },
+
+  // Where the site is stored. Once this is set, builds include the admin panel at /admin.
+  // See README.md for how to set up sign-in.
+  // backend: github({ repo: "your-name/your-site" }),
+  // backend: gitlab({ project: "your-name/your-site", clientId: "your-application-id" }),
+});

package/templates/starter/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@goodfellow-cms/template-starter",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "goodfellow dev",
+    "build": "goodfellow build",
+    "preview": "goodfellow preview",
+    "typecheck": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@goodfellow-cms/admin": "workspace:*",
+    "@goodfellow-cms/blocks": "workspace:*",
+    "@goodfellow-cms/core": "workspace:*",
+    "@goodfellow-cms/github": "workspace:*",
+    "@goodfellow-cms/gitlab": "workspace:*",
+    "@goodfellow-cms/react": "workspace:*",
+    "@puckeditor/core": "0.23.0",
+    "class-variance-authority": "0.7.1",
+    "clsx": "2.1.1",
+    "cn": "0.4.0",
+    "embla-carousel-react": "8.6.0",
+    "lucide-react": "1.52.0",
+    "radix-ui": "1.7.0",
+    "react": "19.3.0",
+    "react-dom": "19.3.0",
+    "tailwind-merge": "3.7.0",
+    "tailwindcss": "4.3.3",
+    "tw-animate-css": "1.4.0"
+  },
+  "devDependencies": {
+    "goodfellow": "workspace:*",
+    "@types/react": "^19.2.0"
+  }
+}

package/templates/starter/public/media/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40"><rect width="40" height="40" rx="10" fill="#1e3a8a"/><path d="M12 28V12h6.5a5 5 0 0 1 0 10H16v6zm4-9.5h2.4a1.75 1.75 0 0 0 0-3.5H16z" fill="#fff"/></svg>

package/templates/starter/public/media/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40"><rect width="40" height="40" rx="10" fill="#1e3a8a"/><path d="M12 28V12h6.5a5 5 0 0 1 0 10H16v6zm4-9.5h2.4a1.75 1.75 0 0 0 0-3.5H16z" fill="#fff"/></svg>

package/templates/starter/public/media/placeholder.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 450"><rect width="800" height="450" fill="#e2e8f0"/><path d="M0 450 260 210l140 130 110-90 290 200z" fill="#cbd5e1"/><circle cx="600" cy="130" r="50" fill="#cbd5e1"/></svg>

package/templates/starter/src/styles.css

@@ -0,0 +1,8 @@
+@import "tailwindcss";
+/* Animations for blocks installed from block registries, such as an FAQ's opening answers. */
+@import "tw-animate-css";
+@import "@goodfellow-cms/react/theme.css";
+@import "@goodfellow-cms/blocks/styles.css";
+
+/* Lets Tailwind find class names typed into the editor. */
+@source "../content";

package/templates/starter/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "skipLibCheck": true,
+    "noEmit": true,
+    // As in shadcn/ui projects: blocks installed from block registries import from "@/components/ui/…".
+    "paths": { "@/*": ["./*"] }
+  },
+  "include": ["goodfellow.config.tsx", "blocks", "components", "lib", "hooks"]
+}

package/templates/starter/vercel.ts

@@ -0,0 +1,65 @@
+// Vercel's settings for this site, which Vercel reads when it builds the site.
+//
+// Vercel also sends the redirects from Site Settings → Redirects (content/redirects.json) itself,
+// so visitors go straight to the new address. Like the pages the build writes at old addresses
+// for other hosts, a redirect from an address a page has is left out: pages always win.
+// This file uses only Node's own modules, since Vercel may read it before installing packages.
+import { existsSync, readdirSync, readFileSync } from "node:fs";
+import { join } from "node:path";
+
+export const config = {
+  framework: null,
+  installCommand: "npm ci",
+  buildCommand: "npx goodfellow build",
+  outputDirectory: "dist",
+  redirects: redirects(),
+};
+
+interface Redirect {
+  from: string;
+  to: string;
+}
+
+function readJson(file: string): Record<string, unknown> | undefined {
+  return existsSync(file) ? JSON.parse(readFileSync(file, "utf8")) : undefined;
+}
+
+/** Every file in a folder and its folders, as paths inside it. */
+function filesIn(dir: string): string[] {
+  if (!existsSync(dir)) return [];
+  return readdirSync(dir, { recursive: true, encoding: "utf8" }).map((file) => file.split("\\").join("/"));
+}
+
+/** The addresses that have pages: `content/pages/about.json` is /about, and each collection item has its own. */
+function pageAddresses(): Set<string> {
+  const addresses = new Set<string>();
+  for (const file of filesIn("content/pages")) {
+    if (file.endsWith(".json")) addresses.add(`/${file.slice(0, -".json".length)}`.replace(/\/?index$/, "") || "/");
+  }
+  for (const id of filesIn("content/collections").filter((file) => file.endsWith("/_collection.json"))) {
+    const folder = id.slice(0, -"/_collection.json".length);
+    const pattern = readJson(join("content/collections", id))?.path;
+    if (typeof pattern !== "string") continue;
+    for (const file of readdirSync(join("content/collections", folder))) {
+      const slug = /^(.+)\.(json|md)$/.exec(file)?.[1];
+      if (slug && file !== "_collection.json") addresses.add(pattern.replace("{slug}", slug).replace(/\/+$/, ""));
+    }
+  }
+  return addresses;
+}
+
+/** An address as Vercel matches it, with the characters its patterns use escaped. */
+function source(path: string): string {
+  return encodeURI(path).replace(/[()[\]{}+*?:!]/g, "\\$&");
+}
+
+function redirects() {
+  const list = (readJson("content/redirects.json")?.redirects ?? []) as Redirect[];
+  const pages = pageAddresses();
+  return list.flatMap(({ from, to }) => {
+    const path = from.replace(/\/+$/, "");
+    if (pages.has(path)) return [];
+    // With and without a trailing slash, as the other hosts serve the page there.
+    return [path, `${path}/`].map((address) => ({ source: source(address), destination: to, permanent: true }));
+  });
+}