@vatvaghool/create-ipl-dashboard 0.1.0 → 0.1.2

package/README.md

@@ -3,7 +3,7 @@
 Scaffold a full-featured IPL fantasy cricket dashboard in seconds.
 
 ```bash
-npx create-ipl-dashboard my-league
+npx @vatvaghool/create-ipl-dashboard my-league
 ```
 
 Follow the prompts to enter your MongoDB URI, fantasy league URL, and team names — then get a ready-to-run Next.js dashboard with standings charts, performance trackers, AI roasts, and more.
@@ -11,7 +11,7 @@ Follow the prompts to enter your MongoDB URI, fantasy league URL, and team names
 ## Usage
 
 ```bash
-npx create-ipl-dashboard [project-name] [options]
+npx @vatvaghool/create-ipl-dashboard [project-name] [options]
 ```
 
 ### Options

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@vatvaghool/create-ipl-dashboard",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Scaffold an IPL fantasy cricket dashboard project",
   "type": "module",
   "bin": {
-    "create-ipl-dashboard": "./src/index.mjs"
+    "create-ipl-dashboard": "src/index.mjs"
   },
   "files": [
     "src",

package/src/generate-template.mjs

@@ -1,4 +1,4 @@
-import { cp, readFile, writeFile, mkdir } from "node:fs/promises";
+import { cp, mkdir } from "node:fs/promises";
 import { existsSync } from "node:fs";
 import { join, dirname, relative } from "node:path";
 import { fileURLToPath } from "node:url";
@@ -23,17 +23,28 @@ const SKIP_PATTERNS = [
   "tsconfig.tsbuildinfo",
 ];
 
-
 async function getAllFiles(dir) {
   const entries = [];
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const { readdir, stat } = await import("node:fs/promises");
   async function walk(current) {
     const items = await readdir(current, { withFileTypes: true });
     for (const item of items) {
       const full = join(current, item.name);
       const rel = relative(MONOREPO_ROOT, full);
-      if (SKIP_PATTERNS.some((p) => rel === p || rel.startsWith(p + "/") || item.name === p)) continue;
-      if (item.name.startsWith(".") && item.name !== ".env.example" && item.name !== ".dockerignore" && item.name !== ".gitignore") continue;
+      if (
+        SKIP_PATTERNS.some(
+          (p) => rel === p || rel.startsWith(p + "/") || item.name === p,
+        )
+      )
+        continue;
+      if (
+        item.name.startsWith(".") &&
+        item.name !== ".env.example" &&
+        item.name !== ".dockerignore" &&
+        item.name !== ".gitignore"
+      )
+        continue;
       if (item.isDirectory()) {
         await walk(full);
       } else {

package/template/README.md

@@ -2,26 +2,13 @@
 
 Private Next.js dashboard for an IPL fantasy league. Combines seeded match history with live leaderboard snapshots to show standings, match-by-match movement, captain picks, cumulative trends, and league insights in one place.
 
-## Screenshots
-
-<!-- TODO: Add screenshots -->
-| Dashboard Overview | Performance Tracker |
-|:---:|:---:|
-| ![](./screenshots/dashboard-overview.png) | ![](./screenshots/performance-tracker.png) |
-
-| Captain Board | Ledger Table |
-|:---:|:---:|
-| ![](./screenshots/captain-board.png) | ![](./screenshots/ledger-table.png) |
-
-| Match Scrubber | AI Roasting |
-|:---:|:---:|
-| ![](./screenshots/match-scrubber.png) | ![](./screenshots/ai-roasting.png) |
-
----
-
 ## Quick Start
 
 ```bash
+# Scaffold a new project
+npx @vatvaghool/create-ipl-dashboard my-league
+
+# Or from source:
 npm install
 ```
 
@@ -43,6 +30,22 @@ Open http://localhost:3000
 
 ---
 
+## Screenshots
+
+| Dashboard Overview | Performance Tracker |
+|:---:|:---:|
+| ![](./screenshots/dashboard-overview.png) | ![](./screenshots/performance-tracker.png) |
+
+| Captain Board | Ledger Table |
+|:---:|:---:|
+| ![](./screenshots/captain-board.png) | ![](./screenshots/ledger-table.png) |
+
+| Match Scrubber | AI Roasting |
+|:---:|:---:|
+| ![](./screenshots/match-scrubber.png) | ![](./screenshots/ai-roasting.png) |
+
+---
+
 ## Components
 
 ### Dashboard Sections
@@ -147,6 +150,54 @@ Also supports a browser bookmarklet — visit `/api/ipl/bookmarklet` while the a
 
 ---
 
+## Deployment
+
+### Deploy to Vercel (recommended)
+
+```bash
+# Build the app
+npm run build
+
+# Deploy to Vercel
+npx vercel --prod
+```
+
+Set these environment variables in your Vercel project dashboard:
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `MONGODB_URI` | Yes | MongoDB connection string |
+| `IPL_POST_SECRET` | Yes | Bearer token protecting write endpoints |
+| `IPL_LEAGUE_URL` | Yes | Your fantasy league page URL |
+| `IPL_DASHBOARD_STALE_MINUTES` | No | Staleness threshold for health checks (default: `20`) |
+| `IPL_TRANSFERS_STALE_MINUTES` | No | Transfer staleness threshold (default: `720`) |
+
+After deployment:
+
+1. Verify the app is healthy — visit `https://your-app.vercel.app/api/ops/status`
+2. Run the Playwright scraper (`npm run sync:cloud`) pointed at your production URL to populate live data
+3. Optionally deploy the scraper as a Cloud Run Job with `Dockerfile.sync` for automated sync every 5-10 minutes
+
+### Without Vercel
+
+```bash
+# Build
+npm run build
+
+# Start production server
+npm start
+```
+
+The app runs as a standard Node.js server on `process.env.PORT` (default `3000`).
+
+### Production requirements
+
+- **MongoDB** is required in production for POST endpoints (returns `503` without it)
+- **IPL_POST_SECRET** should be a strong random value set in your hosting environment
+- The scraper should run outside the web app (Cloud Run, GitHub Actions, cron) — never in the same process
+
+---
+
 ## Stack
 
 - **Next.js** 16 App Router