@pradip1995/create-storefront-app 0.2.3 → 0.3.0

package/lib/scaffold-docker.js

@@ -0,0 +1,82 @@
+import { cpSync, existsSync, mkdirSync, readFileSync, writeFileSync, chmodSync } from "fs"
+import { join, dirname } from "path"
+import { fileURLToPath } from "url"
+import { buildDockerTemplateVars } from "./docker-template-vars.js"
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+const PKG_ROOT = join(__dirname, "..")
+const DOCKER_TEMPLATE = join(PKG_ROOT, "templates", "docker")
+
+function applyTemplate(content, vars) {
+  return content.replace(/\{\{(\w+)\}\}/g, (_, key) => vars[key] ?? "")
+}
+
+function writeTemplatedFile(srcPath, destPath, vars) {
+  writeFileSync(destPath, applyTemplate(readFileSync(srcPath, "utf8"), vars))
+}
+
+function copyBinaryOrTemplate(srcPath, destPath, vars, { binary = false } = {}) {
+  if (binary) {
+    cpSync(srcPath, destPath)
+    return
+  }
+  writeTemplatedFile(srcPath, destPath, vars)
+}
+
+/** Copy Docker Compose stack, Makefile, and docker/ config to project root */
+export function scaffoldDocker(projectRoot, args) {
+  const vars = buildDockerTemplateVars(args)
+
+  writeTemplatedFile(join(DOCKER_TEMPLATE, "docker-compose.yml"), join(projectRoot, "docker-compose.yml"), vars)
+  writeTemplatedFile(
+    join(DOCKER_TEMPLATE, "docker-compose.infra.yml"),
+    join(projectRoot, "docker-compose.infra.yml"),
+    vars
+  )
+  writeTemplatedFile(join(DOCKER_TEMPLATE, "Makefile"), join(projectRoot, "Makefile"), vars)
+
+  const dockerDir = join(projectRoot, "docker")
+  mkdirSync(join(dockerDir, "postgres"), { recursive: true })
+  mkdirSync(join(projectRoot, "data"), { recursive: true })
+
+  writeTemplatedFile(
+    join(DOCKER_TEMPLATE, "docker", ".env.example"),
+    join(dockerDir, ".env.example"),
+    vars
+  )
+  writeTemplatedFile(join(DOCKER_TEMPLATE, "docker", ".env.example"), join(dockerDir, ".env"), vars)
+  writeTemplatedFile(
+    join(DOCKER_TEMPLATE, "docker", "frontend.build.defaults"),
+    join(dockerDir, "frontend.build.defaults"),
+    vars
+  )
+  cpSync(join(DOCKER_TEMPLATE, "docker", "gitignore"), join(dockerDir, ".gitignore"))
+  copyBinaryOrTemplate(
+    join(DOCKER_TEMPLATE, "docker", "postgres", "docker-entrypoint-wrapper.sh"),
+    join(dockerDir, "postgres", "docker-entrypoint-wrapper.sh"),
+    vars,
+    { binary: true }
+  )
+  chmodSync(join(dockerDir, "postgres", "docker-entrypoint-wrapper.sh"), 0o755)
+  writeTemplatedFile(
+    join(DOCKER_TEMPLATE, "docker", "postgres", "01-create-postgres-role.sql"),
+    join(dockerDir, "postgres", "01-create-postgres-role.sql"),
+    vars
+  )
+
+  const dataReadme = join(DOCKER_TEMPLATE, "data", "README.md")
+  if (existsSync(dataReadme)) {
+    writeTemplatedFile(dataReadme, join(projectRoot, "data", "README.md"), vars)
+  }
+  cpSync(join(DOCKER_TEMPLATE, "data", "dump.sql"), join(projectRoot, "data", "dump.sql"))
+
+  cpSync(join(DOCKER_TEMPLATE, "backend", "Dockerfile"), join(projectRoot, "backend", "Dockerfile"))
+  cpSync(join(DOCKER_TEMPLATE, "backend", ".dockerignore"), join(projectRoot, "backend", ".dockerignore"))
+  cpSync(join(DOCKER_TEMPLATE, "storefront", "Dockerfile"), join(projectRoot, "storefront", "Dockerfile"))
+  cpSync(
+    join(DOCKER_TEMPLATE, "storefront", ".dockerignore"),
+    join(projectRoot, "storefront", ".dockerignore")
+  )
+
+  return projectRoot
+}

package/lib/versions.js

@@ -1,7 +1,8 @@
 /** Published package semver ranges — bump when releasing framework/components. */
-export const COMMERCE_CORE_VERSION = "^4.0.0"
-export const FRAMEWORK_VERSION = "^0.2.0"
-export const COMPONENTS_VERSION = "^0.2.0"
+export const COMMERCE_CORE_VERSION = "^4.0.2"
+export const FRAMEWORK_VERSION = "^0.2.1"
+export const FRAMEWORK_COMPILER_VERSION = "^0.2.4"
+export const COMPONENTS_VERSION = ">=0.2.0 <0.4.0"
 
 export const FRAMEWORK_PACKAGES = [
   "@pradip1995/plugin-sdk",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pradip1995/create-storefront-app",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "Scaffold a segment-based Medusa storefront using @pradip1995/framework packages",
   "license": "MIT",
   "type": "module",
@@ -25,6 +25,7 @@
     "node": ">=20"
   },
   "scripts": {
-    "typecheck": "node --check bin/create-storefront-app.js && node --check lib/deps.js && node --check lib/versions.js"
+    "typecheck": "node --check bin/create-storefront-app.js && node --check lib/deps.js && node --check lib/versions.js && node --check lib/scaffold-backend.js && node --check lib/build-backend-package.js && node --check lib/scaffold-docker.js && node --check lib/docker-template-vars.js",
+    "verify-publish": "node scripts/verify-publish.mjs"
   }
 }

package/templates/backend/.cursor/commands/seed-backend.md

@@ -0,0 +1,16 @@
+# Seed Medusa backend
+
+From project root:
+
+```bash
+cd backend
+npm run seed
+```
+
+Requires PostgreSQL running and `DATABASE_URL` set in `backend/.env`.
+
+After seed:
+
+1. Start backend: `npm run dev`
+2. Copy publishable API key from Admin into `storefront/.env.local`
+3. Start storefront: `cd ../storefront && npm run dev`

package/templates/backend/.cursor/rules/medusa-backend.mdc

@@ -0,0 +1,55 @@
+---
+description: Medusa backend — config, plugins, env, seed
+globs: backend/**/*
+alwaysApply: false
+---
+
+# Medusa backend
+
+## Key files
+
+| File | Purpose |
+|------|---------|
+| `medusa-config.ts` | Plugins + modules wiring |
+| `config/medusa-plugin-versions.json` | npm version map for all plugins |
+| `config/homepage-config.json` | Dynamic-config schema (sync with storefront build) |
+| `.env` | Database, CORS, secrets, integrations |
+| `src/scripts/seed.ts` | Region, sales channel, publishable API key, sample product |
+
+## Commands
+
+```bash
+cd backend
+npm run dev      # medusa develop
+npm run build    # medusa build
+npm run seed     # medusa exec ./src/scripts/seed.ts
+```
+
+## Docker
+
+From project root: `make up-infra` then local `npm run dev`, or `make up` for full containerized stack. See `Makefile`.
+
+## After seed
+
+1. Open Medusa Admin → Settings → Publishable API Keys
+2. Copy token into `storefront/.env.local` as `NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY`
+
+## Plugin versions
+
+Edit `config/medusa-plugin-versions.json`, then update `package.json` dependencies to match and run `npm install`.
+
+## CORS
+
+`STORE_CORS` and `AUTH_CORS` must include the storefront URL (`STOREFRONT_URL`).
+
+## Dynamic config
+
+Homepage fields in Admin come from `config/homepage-config.json` (registered in `medusa-config.ts`).
+
+After editing the schema, run:
+
+```bash
+npm run dynamic-config:defaults
+```
+
+The storefront reads **runtime values** from `GET /store/dynamic-config` — it does not generate or import schema files.

package/templates/backend/config/README.md

@@ -0,0 +1,21 @@
+# Dynamic config (backend)
+
+| File | Purpose |
+|------|---------|
+| `homepage-config.json` | **Schema** — field definitions for Medusa Admin (`medusa-plugin-dynamic-config`) |
+| `homepage-config.defaults.json` | **Default values** extracted from schema `defaultValue` fields (reference + bootstrap) |
+
+## Workflow
+
+1. Edit `homepage-config.json` when adding/removing admin fields.
+2. Run `npm run dynamic-config:defaults` to refresh default values.
+3. Restart backend — schema is loaded from `medusa-config.ts`.
+4. Set live content in **Medusa Admin** (Dynamic Config).
+
+The **storefront does not copy this schema**. It reads runtime values from:
+
+```
+GET /store/dynamic-config
+```
+
+Configure values in Admin after `npm run seed`.