create-appraise 0.1.0

package/README.md

@@ -0,0 +1,52 @@
+# create-appraise
+
+Scaffold a new [Appraise](https://github.com/your-org/appraise) app in your directory.
+
+## Usage
+
+```bash
+npx create-appraise@latest
+```
+
+The CLI will prompt you for:
+
+1. **Project directory** – Where to create the app (default: `./my-appraise-app`). The directory must be empty or not exist.
+2. **Package manager** – `npm`, `pnpm`, `yarn`, or `bun`.
+3. **Run install** – Whether to run the package manager install step after copying the template.
+
+Progress is shown while copying the template. When finished, you'll see the project path and next steps (e.g. `cd <dir>`, `npm run setup`, `npm run dev`).
+
+By default, the template is **downloaded from the official Appraise GitHub repository** (tarball first, then git clone if the tarball fails). You can override this with environment variables or use the bundled template for offline use.
+
+### Template source and environment variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `CREATE_APPRAISE_REPO_URL` | Git repository base URL (e.g. `https://github.com/owner/appraisejs-core`). Used for both tarball and clone. | `https://github.com/jamil2018/appraisejs-core` |
+| `CREATE_APPRAISE_BRANCH` | Branch or ref to use. | `main` |
+| `CREATE_APPRAISE_TEMPLATE_SUBPATH` | Path inside the repo to the template directory (relative to repo root). | `templates/default` |
+| `CREATE_APPRAISE_USE_BUNDLED` | Set to `1`, `true`, or `yes` to skip download and use the template bundled in the package. Use for offline or when both download methods fail. | not set (download from repo) |
+
+Download order: the CLI tries the GitHub tarball URL first (no git required); if that fails, it falls back to `git clone`. If both fail, set `CREATE_APPRAISE_USE_BUNDLED=1` to use the bundled template instead.
+
+## After scaffolding
+
+From the new project directory:
+
+1. **If you skipped install:** run your package manager's install (e.g. `npm install --legacy-peer-deps`).
+2. Run setup: `npm run setup` (creates `.env`, runs migrations, installs Playwright).
+3. Sync entities: `npm run sync-all`.
+4. Start the dev server: `npm run dev`.
+
+See the project's `README.md` for full details.
+
+## Publishing to npm
+
+From the repo root or this package directory:
+
+1. Ensure the package builds: `npm run build` (syncs templates and compiles TypeScript).
+2. Bump version in `package.json` if needed.
+3. Log in to npm: `npm login`.
+4. Publish: `npm publish` (from `packages/create-appraise`).
+
+The `files` field in `package.json` includes only `dist` and `templates`, so source and dev dependencies are not published.

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "create-appraise",
+  "version": "0.1.0",
+  "description": "Scaffold a new Appraise app in your directory",
+  "license": "Apache-2.0",
+  "author": "Hasnat Jamil",
+  "homepage": "https://github.com/jamil2018/appraise#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jamil2018/appraise.git",
+    "directory": "packages/create-appraise"
+  },
+  "bugs": {
+    "url": "https://github.com/jamil2018/appraise/issues"
+  },
+  "keywords": [
+    "appraise",
+    "testing",
+    "qa",
+    "cucumber",
+    "playwright",
+    "nextjs",
+    "scaffold"
+  ],
+  "type": "module",
+  "main": "./dist/cli.js",
+  "bin": {
+    "create-appraise": "./dist/cli.js"
+  },
+  "exports": {
+    ".": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "scripts": {
+    "build": "npm run sync-templates && tsc",
+    "sync-templates": "tsx scripts/sync-templates.ts",
+    "test": "vitest run",
+    "test:e2e": "vitest run --config vitest.e2e.config.ts"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^7.2.0",
+    "cli-progress": "^3.12.0",
+    "fs-extra": "^11.2.0",
+    "tar": "^7.0.0"
+  },
+  "devDependencies": {
+    "@types/cli-progress": "^3.11.6",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.17.16",
+    "tsx": "^4.20.4",
+    "typescript": "^5.7.3",
+    "vitest": "^2.1.8"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "overrides": {
+    "esbuild": "^0.25.0"
+  }
+}

package/templates/default/.env.example

@@ -0,0 +1,2 @@
+# Database configuration for local development
+DATABASE_URL="file:./prisma/dev.db"

package/templates/default/README.md

@@ -0,0 +1,51 @@
+# Appraise Starter Template
+
+This is a standalone Appraise starter project. Copy this folder into a new directory to start a new project.
+
+## Prerequisites
+
+- Node.js 18+
+- npm, pnpm, or yarn
+
+## Quick start
+
+```bash
+# 1. Install dependencies
+npm install --legacy-peer-deps
+
+# 2. Setup: create .env, run migrations, install Playwright
+npm run setup
+
+# 3. Sync entities from filesystem to database
+npm run sync-all
+
+# 4. Start the dev server
+npm run dev
+```
+
+## What you get
+
+- **URL**: Open [http://localhost:3000](http://localhost:3000) in your browser.
+- **UI**: The full Appraise dashboard and UI — same as the main Appraise app. You can manage test suites, test cases, template steps, locators, environments, tags, and run tests.
+
+## Scripts
+
+| Script                   | Description                                                                                                     |
+| ------------------------ | --------------------------------------------------------------------------------------------------------------- |
+| `npm run dev`            | Start Next.js dev server                                                                                        |
+| `npm run build`          | Build for production                                                                                            |
+| `npm run start`          | Start production server                                                                                         |
+| `npm run setup`          | Install deps, create .env, migrate DB, install Playwright                                                       |
+| `npm run appraise:setup` | Alias for `setup`                                                                                               |
+| `npm run sync-all`       | Sync all entities (modules, environments, tags, steps, locators, test suites, test cases) from filesystem to DB |
+| `npm run appraise:sync`  | Alias for `sync-all`                                                                                            |
+| `npm run test`           | Run Cucumber tests                                                                                              |
+
+## Configuration
+
+- Copy `.env.example` to `.env` before running (or let `npm run setup` create it). Required: `DATABASE_URL="file:./prisma/dev.db"` for SQLite.
+- `appraise.config.json` — minimal starter config for future CLI/tooling.
+
+## Note
+
+`npm run setup` runs `install-playwright`, which may require network access and a few minutes. The first `sync-all` run will sync entities from the included `src/tests` structure (locators, steps, environments) into the database.

package/templates/default/appraise.config.json

@@ -0,0 +1,4 @@
+{
+  "name": "appraise-starter",
+  "description": "Appraise starter template - copy this folder to start a new project"
+}

package/templates/default/components.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "new-york",
+  "rsc": true,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.ts",
+    "css": "src/app/globals.css",
+    "baseColor": "slate",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "iconLibrary": "lucide",
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib",
+    "hooks": "@/hooks"
+  },
+  "registries": {
+    "@kokonutui": "https://kokonutui.com/r/{name}.json"
+  }
+}

package/templates/default/eslint.config.mjs

@@ -0,0 +1,15 @@
+import nextCoreWebVitals from "eslint-config-next/core-web-vitals";
+import nextTypescript from "eslint-config-next/typescript";
+
+const eslintConfig = [
+  ...nextCoreWebVitals,
+  ...nextTypescript,
+  {
+    ignores: [
+      "src/tests/steps/**/*.step.ts", // Exclude generated template step files
+      "src/tests/steps/**/*", // Exclude all files in steps directory
+    ],
+  },
+];
+
+export default eslintConfig;

package/templates/default/next-env.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+import "./.next/types/routes.d.ts";
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

package/templates/default/next.config.ts

@@ -0,0 +1,7 @@
+import type { NextConfig } from 'next'
+
+const nextConfig: NextConfig = {
+  /* config options here */
+}
+
+export default nextConfig