create-trokky 0.1.1

package/manifest.json

@@ -0,0 +1,330 @@
+{
+  "manifestVersion": 2,
+  "groups": [
+    {
+      "id": "runtime",
+      "title": "Runtime",
+      "hint": "Where the thing runs. This one decides most of the rest."
+    },
+    {
+      "id": "storage",
+      "title": "Storage",
+      "hint": "Where content, uploads and thumbnails live."
+    },
+    {
+      "id": "stack",
+      "title": "Stack",
+      "hint": "How much of Trokky you want, and what is in it on day one."
+    }
+  ],
+  "axes": [
+    {
+      "id": "target",
+      "group": "runtime",
+      "title": "Where will it run?",
+      "options": [
+        {
+          "id": "workers",
+          "title": "Cloudflare Workers",
+          "hint": "No server, no disk. D1 + R2."
+        },
+        {
+          "id": "node",
+          "title": "Node / Express",
+          "hint": "A server you run: VPS, Docker, Railway."
+        }
+      ]
+    },
+    {
+      "id": "data",
+      "group": "storage",
+      "title": "Where does content live?",
+      "options": [
+        {
+          "id": "filesystem-data",
+          "title": "JSON files on disk",
+          "hint": "Readable, diffable, committable."
+        },
+        {
+          "id": "postgres-data",
+          "title": "PostgreSQL",
+          "hint": "For more than one editor."
+        },
+        {
+          "id": "cloudflare-d1",
+          "title": "Cloudflare D1",
+          "hint": "SQLite at the edge."
+        }
+      ]
+    },
+    {
+      "id": "media",
+      "group": "storage",
+      "title": "Where do uploads live?",
+      "options": [
+        {
+          "id": "filesystem-media",
+          "title": "Files on disk",
+          "hint": "Needs a path that survives a restart."
+        },
+        {
+          "id": "cloudflare-r2",
+          "title": "Cloudflare R2",
+          "hint": "Object storage, no disk."
+        },
+        {
+          "id": "s3-media",
+          "title": "S3-compatible storage",
+          "hint": "R2, MinIO, S3, Backblaze. Credentials, not a binding."
+        }
+      ]
+    },
+    {
+      "id": "images",
+      "group": "storage",
+      "title": "How are thumbnails made?",
+      "options": [
+        {
+          "id": "sharp",
+          "title": "sharp",
+          "hint": "Local processing. Node only."
+        },
+        {
+          "id": "cloudflare-images",
+          "title": "Cloudflare Images",
+          "hint": "At upload, through the binding."
+        },
+        {
+          "id": "none",
+          "title": "None",
+          "hint": "Store originals only."
+        }
+      ]
+    },
+    {
+      "id": "parts",
+      "group": "stack",
+      "title": "What do you want?",
+      "options": [
+        {
+          "id": "api",
+          "title": "API only",
+          "hint": "Headless. Bring your own frontend."
+        },
+        {
+          "id": "studio",
+          "title": "API + Studio",
+          "hint": "The admin UI, for editors."
+        },
+        {
+          "id": "full-site",
+          "title": "API + Studio + a site",
+          "hint": "An Astro frontend as well."
+        }
+      ]
+    },
+    {
+      "id": "content",
+      "group": "stack",
+      "title": "Start with content?",
+      "options": [
+        {
+          "id": "blank",
+          "title": "Blank",
+          "hint": "No schemas. Write your own."
+        },
+        {
+          "id": "magazine",
+          "title": "Magazine",
+          "hint": "Articles, authors, categories, documents, pages."
+        }
+      ]
+    }
+  ],
+  "constraints": [
+    {
+      "id": "workers-data",
+      "when": {
+        "target": "workers"
+      },
+      "allow": {
+        "data": [
+          "cloudflare-d1"
+        ]
+      },
+      "because": "A Worker has no disk, and the Postgres adapter needs a TCP client. D1 is the data store at the edge."
+    },
+    {
+      "id": "workers-media",
+      "when": {
+        "target": "workers"
+      },
+      "allow": {
+        "media": [
+          "cloudflare-r2"
+        ]
+      },
+      "because": "A Worker has no disk. R2 is the media adapter that needs none, and inside a Worker its binding beats the S3 API: no credentials to hold."
+    },
+    {
+      "id": "workers-images",
+      "when": {
+        "target": "workers"
+      },
+      "allow": {
+        "images": [
+          "cloudflare-images",
+          "none"
+        ]
+      },
+      "because": "sharp is a native libvips binding and Workers runs no native code."
+    },
+    {
+      "id": "node-data",
+      "when": {
+        "target": "node"
+      },
+      "allow": {
+        "data": [
+          "filesystem-data",
+          "postgres-data"
+        ]
+      },
+      "because": "D1 arrives as a Worker binding; there is nothing for a Node process to connect to."
+    },
+    {
+      "id": "node-media",
+      "when": {
+        "target": "node"
+      },
+      "allow": {
+        "media": [
+          "filesystem-media",
+          "s3-media"
+        ]
+      },
+      "because": "R2 arrives as a Worker binding, so a Node process reaches it over the S3 API instead \u2014 which also reaches MinIO, Backblaze and S3."
+    },
+    {
+      "id": "node-images",
+      "when": {
+        "target": "node"
+      },
+      "allow": {
+        "images": [
+          "sharp",
+          "none"
+        ]
+      },
+      "because": "The Cloudflare Images binding only exists inside a Worker."
+    },
+    {
+      "id": "content-needs-schemas",
+      "when": {
+        "parts": "full-site"
+      },
+      "allow": {
+        "content": [
+          "magazine"
+        ]
+      },
+      "because": "A site needs something to render. Choose the magazine content model, or drop the frontend."
+    }
+  ],
+  "defaults": {
+    "workers": {
+      "data": "cloudflare-d1",
+      "media": "cloudflare-r2",
+      "images": "cloudflare-images",
+      "parts": "full-site",
+      "content": "magazine"
+    },
+    "node": {
+      "data": "filesystem-data",
+      "media": "filesystem-media",
+      "images": "sharp",
+      "parts": "studio",
+      "content": "magazine"
+    }
+  },
+  "secrets": [
+    {
+      "when": {
+        "target": "workers"
+      },
+      "secrets": [
+        {
+          "name": "TROKKY_JWT_SECRET",
+          "generate": "hex32",
+          "why": "Signs sessions and tokens. Must stay the same across deploys, or every login is invalidated."
+        },
+        {
+          "name": "TROKKY_CLAIM_SECRET",
+          "generate": "hex24",
+          "why": "Lets the first person to open Studio claim the instance as its administrator. A one-time token you type once, not a password to remember. Without it the claim is open to whoever reaches the URL first."
+        }
+      ]
+    },
+    {
+      "when": {
+        "target": "node"
+      },
+      "secrets": [
+        {
+          "name": "TROKKY_JWT_SECRET",
+          "generate": "hex32",
+          "why": "Signs sessions and tokens. Must stay the same across restarts, or every login is invalidated."
+        },
+        {
+          "name": "TROKKY_CLAIM_SECRET",
+          "generate": "hex24",
+          "why": "Lets the first person to open Studio claim the instance as its administrator. A one-time token you type once, not a password to remember. Without it the claim is open to whoever reaches the URL first."
+        }
+      ]
+    },
+    {
+      "when": {
+        "media": "s3-media"
+      },
+      "secrets": [
+        {
+          "name": "S3_ENDPOINT",
+          "why": "The bucket service endpoint, e.g. https://<account>.r2.cloudflarestorage.com"
+        },
+        {
+          "name": "S3_BUCKET",
+          "why": "The bucket name. Create it before the first upload."
+        },
+        {
+          "name": "S3_ACCESS_KEY_ID",
+          "why": "An access key with read and write on that bucket."
+        },
+        {
+          "name": "S3_SECRET_ACCESS_KEY",
+          "why": "Its secret. Never commit this."
+        },
+        {
+          "name": "S3_REGION",
+          "why": "Optional. SigV4 signs over a region whether or not the backend has one; defaults to 'auto', which is what R2 wants.",
+          "optional": true
+        }
+      ]
+    }
+  ],
+  "templates": [
+    {
+      "id": "magazine",
+      "title": "The magazine template",
+      "repo": "https://github.com/Trokky/trokky-template",
+      "deployButton": "https://deploy.workers.cloudflare.com/?url=https://github.com/Trokky/trokky-template",
+      "composition": {
+        "target": "workers",
+        "data": "cloudflare-d1",
+        "media": "cloudflare-r2",
+        "images": "cloudflare-images",
+        "parts": "full-site",
+        "content": "magazine"
+      }
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "create-trokky",
+  "version": "0.1.1",
+  "description": "Compose a Trokky project: pick the target, adapters and parts you want.",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Trokky/generator.git"
+  },
+  "bin": {
+    "create-trokky": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./manifest.json": "./manifest.json",
+    "./node": {
+      "types": "./dist/node.d.ts",
+      "import": "./dist/node.js"
+    },
+    "./generated/files-text": {
+      "types": "./dist/generated/files-text.d.ts",
+      "import": "./dist/generated/files-text.js"
+    },
+    "./generated/files-binary": {
+      "types": "./dist/generated/files-binary.d.ts",
+      "import": "./dist/generated/files-binary.js"
+    }
+  },
+  "files": [
+    "dist",
+    "files",
+    "manifest.json"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "node scripts/inline-files.mjs && tsc -p tsconfig.json",
+    "test": "vitest run",
+    "check": "tsc -p tsconfig.json --noEmit",
+    "smoke": "node scripts/smoke.mjs",
+    "inline": "node scripts/inline-files.mjs"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "aws4fetch": "^1.0.20",
+    "typescript": "^5.6.0",
+    "vitest": "^3.2.4"
+  },
+  "keywords": [
+    "trokky",
+    "cms",
+    "scaffold",
+    "generator",
+    "cloudflare-workers"
+  ]
+}