@pradip1995/create-storefront-app 0.2.2 → 0.3.0

package/templates/shared/README.md

@@ -0,0 +1,100 @@
+# {{PROJECT_NAME}}
+
+Full-stack Medusa shop: **backend** (Medusa v2) + **storefront** (segment-based Next.js).
+
+Run **with Docker**, **Docker infra + local Node**, or **fully local** (PostgreSQL + Redis on host).
+
+## Prerequisites
+
+- **Node.js 20+**
+- **npm 9+**
+- **Docker Desktop** (optional — for `make up` / `make up-infra`)
+- **PostgreSQL + Redis** on host when running fully local without Docker infra
+
+All `@pradip1995/*` packages and Medusa plugins resolve from the **public npm registry** — no monorepo or private registry required.
+
+## Option A — Full stack in Docker
+
+```bash
+make env-init    # docker/.env from example (already created on scaffold)
+make up          # build + start postgres, redis, mailpit, backend, storefront
+make migrate     # DB migrations (fresh DB may need two runs)
+make seed        # region, publishable key, sample product
+make admin-create
+```
+
+| Service    | URL |
+|------------|-----|
+| Storefront | {{BASE_URL}}/{{DEFAULT_REGION}} |
+| Admin      | {{BACKEND_URL}}/app |
+| API        | {{BACKEND_URL}} |
+| Mailpit    | http://localhost:8025 |
+
+After `make seed`, update `docker/frontend.build.defaults` and `storefront/.env.local` with the publishable key, then `make build-storefront` if using Docker for the storefront.
+
+Default admin: `make admin-create` (see `Makefile` for `ADMIN_EMAIL` / `ADMIN_PASSWORD`).
+
+## Option B — Docker infra + local Node dev
+
+```bash
+make up-infra              # postgres, redis, mailpit only
+npm run dev:backend        # terminal 1 — uses backend/.env DATABASE_URL
+npm run seed               # from project root, or cd backend && npm run seed
+npm run dev:storefront     # terminal 2
+```
+
+`backend/.env` `DATABASE_URL` matches Docker postgres credentials from scaffold.
+
+For OTP/email in local backend with infra Docker, set `SMTP_HOST=localhost` and `SMTP_PORT=1025` (Mailpit exposes SMTP when using `docker-compose.infra.yml`).
+
+## Option C — Fully local (no Docker)
+
+```bash
+cd backend && npm install
+# Edit .env — PostgreSQL + Redis on localhost
+npm run dev
+npm run seed
+
+cd ../storefront && npm install
+# Edit .env.local — publishable key from Admin
+npm run dev
+```
+
+## Daily dev (local Node)
+
+```bash
+npm run dev:backend      # terminal 1
+npm run dev:storefront   # terminal 2
+```
+
+## Build production
+
+```bash
+npm run build:backend
+npm run build:storefront
+# or
+make build
+```
+
+## Docker commands
+
+```bash
+make help          # all targets
+make up-infra      # postgres + redis + mailpit
+make up-backend    # infra + backend container
+make logs          # tail logs
+make db-shell      # psql
+make clean         # remove containers + volumes
+```
+
+## Customize
+
+| Goal | Where |
+|------|--------|
+| Home sections | `storefront/pages.config.json` |
+| Colors / fonts | `storefront/theme-overrides.css` |
+| Medusa plugins | `backend/medusa-config.ts` + `backend/config/medusa-plugin-versions.json` |
+| Homepage admin fields | `backend/config/homepage-config.json` |
+| Docker secrets | `docker/.env` |
+
+Cursor guides: `.cursor/` in each folder.

package/templates/shared/root-gitignore

@@ -0,0 +1,6 @@
+node_modules
+.DS_Store
+*.log
+.env
+.env.local
+docker/.env

package/templates/shared/storefront-only-README.md

@@ -0,0 +1,25 @@
+# {{PROJECT_NAME}}
+
+Segment-based Medusa storefront (config client).
+
+## Setup
+
+```bash
+npm install
+# Edit .env.local — Medusa URL + publishable key
+npm run dev
+```
+
+Storefront: {{BASE_URL}}/{{DEFAULT_REGION}}
+
+## Customize
+
+| Goal | File |
+|------|------|
+| Home sections | `pages.config.json` |
+| Colors / fonts | `theme-overrides.css` |
+| Brand assets | `public/` |
+
+After config changes: `npm run storefront:build && npm run dev`
+
+Cursor guides: `.cursor/`

package/templates/shared/theme-overrides.css

@@ -0,0 +1,16 @@
+/**
+ * Brand color & font overrides.
+ * Copied into .generated-app on each `npm run storefront:build`.
+ * Override CSS variables from @pradip1995/segment-tokens/themes/impulse.css
+ */
+:root {
+  /* Example — uncomment and edit:
+  --color-brand-accent: #5a2a43;
+  --color-brand-accent-hover: #723a56;
+  --color-brand-pink: #c68a8a;
+  --color-page-bg: #ffffff;
+  --color-footer-bg: #1a1a1a;
+  --font-sans: "Montserrat", sans-serif;
+  --font-heading: "Playfair Display", serif;
+  */
+}