create-pollar-app-patrickkish 0.1.0 → 0.1.2

package/README.md

@@ -1,50 +1,150 @@
 # create-pollar-app-patrickkish
 
-CLI that scaffolds a ready-to-run **Next.js 16 + Pollar** app. Closes [pollar-backoffice#2](https://github.com/pollar-xyz/pollar-backoffice/issues/2).
+Scaffold a **Next.js 16** app with [**Pollar**](https://docs.pollar.xyz) wallet already wired — login, balance, assets, send, receive, and transaction history via the official SDK.
 
-## Usage
+Built for [pollar-backoffice#2](https://github.com/pollar-xyz/pollar-backoffice/issues/2).
+
+## Quick start
+
+The issue acceptance path is **`npx`** — it works for everyone regardless of which package manager you use in the generated app.
+
+### npx (primary — issue #2 flow)
+
+```bash
+npx create-pollar-app-patrickkish@latest my-pollar-app
+cd my-pollar-app
+# edit .env.local — set NEXT_PUBLIC_POLLAR_API_KEY=pub_testnet_...
+npm run dev
+```
+
+Non-interactive:
+
+```bash
+npx create-pollar-app-patrickkish@latest my-pollar-app --yes --pm pnpm --network testnet
+```
+
+Use `--pm` to pick the package manager for the **new app** (defaults to npm when invoked via npx).
+
+### pnpm (team preference)
+
+```bash
+pnpm dlx create-pollar-app-patrickkish@latest my-pollar-app
+cd my-pollar-app
+# edit .env.local — set NEXT_PUBLIC_POLLAR_API_KEY=pub_testnet_...
+pnpm dev
+```
+
+Non-interactive:
+
+```bash
+pnpm dlx create-pollar-app-patrickkish@latest my-pollar-app -- --yes --pm pnpm --network testnet
+```
+
+### npm
+
+Equivalent to npx (no `npx` prefix needed):
+
+```bash
+npm create create-pollar-app-patrickkish@latest my-pollar-app
+cd my-pollar-app
+# edit .env.local
+npm run dev
+```
+
+Non-interactive:
 
 ```bash
-# Interactive (pnpm recommended)
-pnpm dlx create-pollar-app-patrickkish my-app
+npm create create-pollar-app-patrickkish@latest my-pollar-app -- --yes --pm npm --network testnet
+```
+
+### yarn
 
-# Non-interactive
-npx create-pollar-app-patrickkish my-app --yes --pm pnpm --network testnet
-npm create create-pollar-app-patrickkish@latest my-app -- --yes --pm npm
-yarn create create-pollar-app-patrickkish my-app --yes --pm yarn
-bunx create-pollar-app-patrickkish my-app --yes --pm bun
+```bash
+yarn create create-pollar-app-patrickkish my-pollar-app
+cd my-pollar-app
+# edit .env.local
+yarn dev
+```
+
+Non-interactive:
+
+```bash
+yarn create create-pollar-app-patrickkish my-pollar-app --yes --pm yarn --network testnet
 ```
 
-### Flags
+### bun
+
+```bash
+bunx create-pollar-app-patrickkish@latest my-pollar-app
+cd my-pollar-app
+# edit .env.local
+bun run dev
+```
+
+Non-interactive:
+
+```bash
+bunx create-pollar-app-patrickkish@latest my-pollar-app --yes --pm bun --network testnet
+```
+
+## What you get
+
+The generated app includes:
+
+- **Next.js 16** App Router, **React 19**, TypeScript, **Tailwind 4**
+- `@pollar/core@^0.9.0` and `@pollar/react@^0.9.0`
+- `PollarProvider` in the root layout
+- Login via **`WalletButton`**
+- Home screen actions that open SDK modals: balance, assets, send (USDC example), receive, history
+- `.env.example`, eslint, prettier, and a README with a Deploy to Vercel button
+
+No backend and no secret keys — client-side only.
+
+## CLI flags
 
 | Flag | Description |
 |------|-------------|
-| `--yes` / `-y` | Skip prompts (defaults: detected package manager, testnet) |
-| `--pm <npm\|pnpm\|yarn\|bun>` | Package manager for install |
-| `--network <testnet\|mainnet>` | Stellar network written to `.env.local` |
+| `--yes` / `-y` | Skip prompts (uses detected package manager + testnet) |
+| `--pm <npm\|pnpm\|yarn\|bun>` | Package manager for installing the new app |
+| `--network <testnet\|mainnet>` | Written to `.env.local` as `NEXT_PUBLIC_POLLAR_NETWORK` |
 
-When you run via `pnpm dlx`, the default package manager is **pnpm**. Same for `npm create`, `yarn create`, and `bunx`.
+When you skip `--pm`, the CLI picks the manager that invoked it (`pnpm dlx` → pnpm, `npm create` → npm, etc.).
 
-## Generated app
+## Environment variables
 
-- `PollarProvider` + `NEXT_PUBLIC_POLLAR_API_KEY`
-- Login with **WalletButton**
-- Home screen opens SDK modals: balance, assets, send (USDC example), receive, history
-- eslint + prettier, README with Deploy to Vercel button
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `NEXT_PUBLIC_POLLAR_API_KEY` | Yes | Publishable key from [dashboard.pollar.xyz](https://dashboard.pollar.xyz) (`pub_testnet_...`) |
+| `NEXT_PUBLIC_POLLAR_NETWORK` | No | `testnet` (default) or `mainnet` |
 
-## Develop this CLI
+Get a testnet key at **dashboard.pollar.xyz → Configuration → API Keys**.
+
+## Requirements
+
+- Node.js **20+**
+- A Pollar publishable API key (free, self-serve)
+
+## Develop this package locally
 
 ```bash
+git clone https://github.com/PatrickKish1/create-pollar-app-patrickkish.git
+cd create-pollar-app-patrickkish
 pnpm install
 node bin/index.js my-test-app --yes --pm pnpm
 ```
 
-## Publish
+## Publish to npm
+
+This package must be **public** so reviewers and users can run `npx` / `pnpm dlx` without npm login:
 
 ```bash
 npm publish --access public
 ```
 
+Do **not** use `--access private` for this deliverable — a private package cannot be installed by maintainers testing issue #2.
+
+A `prepublishOnly` script blocks publishing if `node_modules` exists inside `template/`.
+
 ## License
 
 MIT

package/lib/create.js

@@ -5,6 +5,7 @@ import { fileURLToPath } from "node:url";
 import prompts from "prompts";
 import { detectPackageManager, installCommand, runCommand } from "./package-manager.js";
 import { copyTemplate } from "./copy-template.js";
+import { printNextSteps } from "./print-next-steps.js";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const TEMPLATE_DIR = path.join(__dirname, "..", "template");
@@ -99,42 +100,17 @@ export async function createApp(options) {
     network,
   });
 
-  console.log(`Installing dependencies with ${packageManager}…`);
-  await runCommand(installCommand(packageManager), targetDir);
-
   console.log("Initializing git repository…");
   await runCommand("git init", targetDir);
   await runCommand("git branch -M main", targetDir).catch(() => undefined);
-  await runCommand("git add .", targetDir);
+
+  console.log(`Installing dependencies with ${packageManager}…`);
+  await runCommand(installCommand(packageManager), targetDir);
+
+  await runCommand("git add -A", targetDir);
   await runCommand('git commit -m "Initial commit from create-pollar-app-patrickkish"', targetDir).catch(
     () => undefined,
   );
 
-  console.log(`
-Success! Created ${projectName}
-
-Next steps:
-  cd ${projectName}
-  Set your Pollar API key in .env.local:
-    NEXT_PUBLIC_POLLAR_API_KEY=pub_testnet_...
-  Get a key at https://dashboard.pollar.xyz
-
-  ${devCommand(packageManager)}
-
-Open http://localhost:3000 — log in with WalletButton and try Send USDC from the home screen.
-`);
-}
-
-/** @param {string} pm */
-function devCommand(pm) {
-  switch (pm) {
-    case "pnpm":
-      return "pnpm dev";
-    case "yarn":
-      return "yarn dev";
-    case "bun":
-      return "bun run dev";
-    default:
-      return "npm run dev";
-  }
+  printNextSteps(projectName, packageManager, network);
 }

package/lib/print-next-steps.js

@@ -0,0 +1,64 @@
+/** @param {string} projectName @param {string} packageManager @param {string} network */
+export function printNextSteps(projectName, packageManager, network) {
+  const keyVar = "NEXT_PUBLIC_POLLAR_API_KEY";
+  const networkVar = "NEXT_PUBLIC_POLLAR_NETWORK";
+
+  const blocks = {
+    pnpm: {
+      create: "pnpm dlx create-pollar-app-patrickkish@latest <name>",
+      install: "pnpm install",
+      dev: "pnpm dev",
+      build: "pnpm build",
+    },
+    npm: {
+      create: "npx create-pollar-app-patrickkish@latest <name>",
+      install: "npm install",
+      dev: "npm run dev",
+      build: "npm run build",
+    },
+    yarn: {
+      create: "yarn create create-pollar-app-patrickkish <name>",
+      install: "yarn install",
+      dev: "yarn dev",
+      build: "yarn build",
+    },
+    bun: {
+      create: "bunx create-pollar-app-patrickkish@latest <name>",
+      install: "bun install",
+      dev: "bun run dev",
+      build: "bun run build",
+    },
+  };
+
+  const pm = blocks[packageManager] ?? blocks.npm;
+  const rescaffoldFlags = `--yes --pm ${packageManager}`;
+  const rescaffoldSep = packageManager === "pnpm" ? " -- " : " ";
+
+  console.log(`
+Success! Created ${projectName}
+
+Next steps:
+
+  1. Go to the project
+     cd ${projectName}
+
+  2. Add your Pollar API key (testnet: https://dashboard.pollar.xyz)
+     Edit .env.local:
+       ${keyVar}=pub_testnet_...
+       ${networkVar}=${network}
+
+  3. Start the dev server
+     ${pm.dev}
+
+  4. Open http://localhost:3000
+     - Log in with WalletButton
+     - Use "Send USDC" on the home screen to try a testnet transfer
+
+Package manager notes (${packageManager}):
+  install: ${pm.install}
+  build:   ${pm.build}
+
+To scaffold another app with ${packageManager}:
+  ${pm.create.replace("<name>", "my-pollar-app")}${rescaffoldSep}${rescaffoldFlags}
+`);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-pollar-app-patrickkish",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Scaffold a Next.js app with Pollar wallet pre-wired",
   "license": "MIT",
   "type": "module",
@@ -17,6 +17,7 @@
     "template"
   ],
   "scripts": {
+    "prepublishOnly": "node scripts/prepublish-check.js",
     "test:cli": "node bin/index.js test-app --yes --pm pnpm --network testnet"
   },
   "dependencies": {

package/template/README.md

@@ -1,38 +1,71 @@
 # Pollar App
 
-A Next.js app scaffolded with [create-pollar-app-patrickkish](https://github.com/PatrickKish1/create-pollar-app-patrickkish). Pollar wallet login, send, receive, balance, assets, and history are provided by the official SDK.
+Next.js starter with [Pollar](https://docs.pollar.xyz) embedded wallet — scaffolded by [create-pollar-app-patrickkish](https://github.com/PatrickKish1/create-pollar-app-patrickkish).
 
 ## Get started in 3 steps
 
-1. **Set your API key** — copy `.env.local` and paste your testnet key from [dashboard.pollar.xyz](https://dashboard.pollar.xyz):
+### 1. Set your API key
 
-   ```bash
-   NEXT_PUBLIC_POLLAR_API_KEY=pub_testnet_...
-   ```
+Open `.env.local` and paste your publishable key from [dashboard.pollar.xyz](https://dashboard.pollar.xyz):
 
-2. **Install and run:**
+```bash
+NEXT_PUBLIC_POLLAR_API_KEY=pub_testnet_xxxxxxxxxxxxxxxxxxxx
+NEXT_PUBLIC_POLLAR_NETWORK=testnet
+```
 
-   ```bash
-   pnpm install   # or npm / yarn / bun
-   pnpm dev
-   ```
+### 2. Install and run
 
-3. **Open** [http://localhost:3000](http://localhost:3000) — log in with **WalletButton**, then use **Send USDC** on the home screen.
+Use the same package manager you chose when scaffolding:
+
+**pnpm**
+
+```bash
+pnpm install   # skip if you just scaffolded — deps are already installed
+pnpm dev
+```
+
+**npm**
+
+```bash
+npm install
+npm run dev
+```
+
+**yarn**
+
+```bash
+yarn install
+yarn dev
+```
+
+**bun**
+
+```bash
+bun install
+bun run dev
+```
+
+### 3. Try it
+
+Open [http://localhost:3000](http://localhost:3000):
+
+1. Log in with **WalletButton** (providers come from your Pollar dashboard)
+2. Click **Send USDC** on the home screen
+3. Complete a testnet send
+
+## What's included
+
+- `PollarProvider` configured from `NEXT_PUBLIC_POLLAR_API_KEY`
+- SDK modals for balance, assets, send, receive, and history
+- eslint + prettier
 
 ## Deploy to Vercel
 
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new?env=NEXT_PUBLIC_POLLAR_API_KEY,NEXT_PUBLIC_POLLAR_NETWORK&envDescription=Pollar%20publishable%20key%20and%20Stellar%20network&project-name=pollar-app)
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?env=NEXT_PUBLIC_POLLAR_API_KEY,NEXT_PUBLIC_POLLAR_NETWORK&envDescription=Pollar%20publishable%20key%20and%20Stellar%20network&project-name=pollar-app)
 
-After deploy, set `NEXT_PUBLIC_POLLAR_API_KEY` in Vercel project settings.
+Add `NEXT_PUBLIC_POLLAR_API_KEY` in your Vercel project settings after deploy.
 
 ## Stack
 
-- Next.js 16 (App Router), React 19, TypeScript, Tailwind 4
+- Next.js 16, React 19, TypeScript 5, Tailwind 4
 - `@pollar/core@^0.9.0`, `@pollar/react@^0.9.0`
-
-## Environment
-
-| Variable | Required | Description |
-|----------|----------|-------------|
-| `NEXT_PUBLIC_POLLAR_API_KEY` | Yes | Pollar publishable key (`pub_testnet_...`) |
-| `NEXT_PUBLIC_POLLAR_NETWORK` | No | `testnet` (default) or `mainnet` |