@vatvaghool/create-ipl-dashboard 0.1.17 → 0.1.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vatvaghool/create-ipl-dashboard",
-  "version": "0.1.17",
+  "version": "0.1.18",
   "description": "Scaffold an IPL fantasy cricket dashboard project",
   "type": "module",
   "bin": {

package/template/README.md

@@ -12,15 +12,7 @@ npx @vatvaghool/create-ipl-dashboard my-league
 npm install
 ```
 
-Create a `.env` file:
-
-```env
-MONGODB_URI=your_mongodb_connection_string
-IPL_LEAGUE_URL=https://fantasy.iplt20.com/classic/league/view/your_league_id
-IPL_POST_SECRET=your_secret_here
-```
-
-Start the app:
+Start the dev server:
 
 ```bash
 npm run dev:simple
@@ -28,6 +20,27 @@ npm run dev:simple
 
 Open http://localhost:3000
 
+### Available commands
+
+| Command | Description |
+|---------|-------------|
+| `npm run dev` | Dev server with welcome splash |
+| `npm run dev:simple` | Dev server (simple, no splash) |
+| `npm run build` | Production build |
+| `npm start` | Production server |
+| `npm run capture:ipl-auth` | Capture Playwright login state (one-time) |
+| `npm run sync:ipl` | Scrape live leaderboard snapshot |
+| `npm run sync:ipl:watch` | Scrape leaderboard in watch mode (polls every 2 min) |
+| `npm run sync:ipl:transfers-daily` | Scrape transfer/booster data |
+| `npm run sync:cloud` | Run both leaderboard + transfer sync (for cloud jobs) |
+| `npm run seed:league` | Seed league metadata into storage |
+| `npm run seed:mongodb` | Seed initial raw user data from `data.ts` |
+| `npm run seed:mongodb:reset` | Reset and re-seed MongoDB data |
+| `npm run verify:production` | Verify production setup |
+| `npm run monitor:ops` | Check ops health status |
+| `npm run test` | Run test suite |
+| `npm run lint` | Run linter |
+
 ---
 
 ## Screenshots
@@ -116,9 +129,9 @@ Open http://localhost:3000
 
 ```
 GET /api/ipl resolution order:
-  1. MongoDB raw users (if MONGODB_URI configured)
+  1. Storage raw users (if configured — MongoDB or Google Sheets)
   2. Fallback: local seed data (app/api/ipl/data.ts)
-  3. MongoDB live snapshot (if MONGODB_URI configured)
+  3. Storage live snapshot (if configured)
   4. Fallback: local snapshot file (app/api/ipl/live-snapshot.json)
 ```
 
@@ -130,11 +143,16 @@ All hardcoded values are centralized in `app/lib/config.ts` and overridable via
 
 | Variable | Default | Description |
 |----------|---------|-------------|
-| `MONGODB_URI` | - | MongoDB connection string |
+| `STORAGE_BACKEND` | `mongodb` | Storage backend: `mongodb` or `google_sheets` |
+| `MONGODB_URI` | - | MongoDB connection string (for MongoDB backend) |
+| `GOOGLE_SHEET_ID` | - | Google Sheet ID (for Google Sheets backend) |
+| `GOOGLE_SERVICE_ACCOUNT_EMAIL` | - | Google service account email |
+| `GOOGLE_PRIVATE_KEY` | - | Google service account private key |
+| `LEAGUE_NAME` | - | League name (collection/sheet name) |
 | `IPL_LEAGUE_URL` | fantasy.iplt20.com/... | Fantasy league page URL |
 | `IPL_POST_SECRET` | - | Bearer token for POST endpoints |
-| `IPL_DB_NAME` | `ipl` | MongoDB database name |
-| `IPL_COLLECTION_NAME` | `ipl` | MongoDB collection name |
+| `IPL_DB_NAME` | `ipl` | MongoDB database name (MongoDB only) |
+| `IPL_COLLECTION_NAME` | `ipl` | MongoDB collection name (MongoDB only) |
 | `IPL_TOTAL_TRANSFERS` | `160` | Total transfers per season |
 | `IPL_SYNC_INTERVAL_MS` | `120000` | Dashboard polling interval |
 | `IPL_DASHBOARD_STALE_MINUTES` | `20` (prod) / `180` (dev) | Staleness threshold |
@@ -144,19 +162,7 @@ All hardcoded values are centralized in `app/lib/config.ts` and overridable via
 
 ## Automation
 
-```bash
-# Capture login state for Playwright scrapers
-npm run capture:ipl-auth
-
-# Scrape live leaderboard snapshot
-npm run sync:ipl
-
-# Scrape transfer/booster data
-npm run sync:ipl:transfers
-
-# Run both in sequence (for cloud jobs)
-npm run sync:cloud
-```
+See the [commands table](#available-commands) above for all options.
 
 Also supports a browser bookmarklet — visit `/api/ipl/bookmarklet` while the app is running, copy the returned `javascript:` code, and save it as a bookmark. Click it on the fantasy leaderboard page to sync data.
 
@@ -178,7 +184,12 @@ Set these environment variables in your Vercel project dashboard:
 
 | Variable | Required | Description |
 |----------|----------|-------------|
-| `MONGODB_URI` | Yes | MongoDB connection string |
+| `STORAGE_BACKEND` | Yes | `mongodb` or `google_sheets` |
+| `MONGODB_URI` | Yes* | MongoDB connection string (required if `mongodb`) |
+| `GOOGLE_SHEET_ID` | Yes* | Google Sheet ID (required if `google_sheets`) |
+| `GOOGLE_SERVICE_ACCOUNT_EMAIL` | Yes* | Service account email (required if `google_sheets`) |
+| `GOOGLE_PRIVATE_KEY` | Yes* | Private key (required if `google_sheets`) |
+| `LEAGUE_NAME` | Yes | Collection or sheet name |
 | `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`) |
@@ -204,7 +215,7 @@ 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)
+- **Storage** (MongoDB or Google Sheets) 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
 
@@ -218,6 +229,6 @@ The app runs as a standard Node.js server on `process.env.PORT` (default `3000`)
 - **Tailwind CSS** 4
 - **Recharts** — charts
 - **Framer Motion** — animations
-- **MongoDB** — data persistence
+- **MongoDB** or **Google Sheets** — data persistence
 - **Zustand** — client state
 - **Playwright** — scraper automation