create-appraise 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +21 -15
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # create-appraise
2
2
 
3
- Scaffold a new [Appraise](https://github.com/your-org/appraise) app in your directory.
3
+ Scaffold a new [Appraise](https://github.com/jamil2018/appraisejs-core) app in your directory.
4
4
 
5
5
  ## Usage
6
6
 
@@ -12,20 +12,26 @@ The CLI will prompt you for:
12
12
 
13
13
  1. **Project directory** – Where to create the app (default: `./my-appraise-app`). The directory must be empty or not exist.
14
14
  2. **Package manager** – `npm`, `pnpm`, `yarn`, or `bun`.
15
- 3. **Run install** – Whether to run the package manager install step after copying the template.
15
+ 3. **Run setup now** – Whether to run the project’s setup script after copying the template (installs dependencies, creates `.env`, runs migrations, installs Playwright). If you skip this, you run setup yourself before starting the app.
16
16
 
17
- 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`).
17
+ **Workflow:**
18
18
 
19
- 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.
19
+ 1. Validates the target directory (must be empty or non-existent).
20
+ 2. Downloads the template from the repo (tarball first, then git clone if the tarball fails), or uses the bundled template when `CREATE_APPRAISE_USE_BUNDLED` is set.
21
+ 3. Copies the template into the target directory and patches `package.json` scripts to use your chosen package manager.
22
+ 4. If you chose to run setup, runs the project’s `setup` script in the new directory.
23
+ 5. Prints the project path and next steps (`cd <dir>`, then `npm run setup` if you skipped, then `npm run dev`).
24
+
25
+ By default, the template is **downloaded from the official Appraise GitHub repository**. You can override this with environment variables or use the bundled template for offline use.
20
26
 
21
27
  ### Template source and environment variables
22
28
 
23
- | Variable | Description | Default |
24
- |----------|-------------|---------|
25
- | `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` |
26
- | `CREATE_APPRAISE_BRANCH` | Branch or ref to use. | `main` |
27
- | `CREATE_APPRAISE_TEMPLATE_SUBPATH` | Path inside the repo to the template directory (relative to repo root). | `templates/default` |
28
- | `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) |
29
+ | Variable | Description | Default |
30
+ | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
31
+ | `CREATE_APPRAISE_REPO_URL` | Git repository base URL (e.g. `https://github.com/jamil2018/appraisejs-core`). Used for both tarball and clone. | `https://github.com/jamil2018/appraisejs-core` |
32
+ | `CREATE_APPRAISE_BRANCH` | Branch or ref to use. | `main` |
33
+ | `CREATE_APPRAISE_TEMPLATE_SUBPATH` | Path inside the repo to the template directory (relative to repo root). | `templates/default` |
34
+ | `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) |
29
35
 
30
36
  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.
31
37
 
@@ -33,12 +39,12 @@ Download order: the CLI tries the GitHub tarball URL first (no git required); if
33
39
 
34
40
  From the new project directory:
35
41
 
36
- 1. **If you skipped install:** run your package manager's install (e.g. `npm install --legacy-peer-deps`).
37
- 2. Run setup: `npm run setup` (creates `.env`, runs migrations, installs Playwright).
38
- 3. Sync entities: `npm run sync-all`.
39
- 4. Start the dev server: `npm run dev`.
42
+ - **If you skipped setup:** run `npm run setup` (or your package manager’s equivalent: `pnpm run setup`, etc.). This installs dependencies, creates `.env`, runs migrations, and installs Playwright.
43
+ - **If you ran setup:** you can go straight to the next step.
44
+ - Sync entities: `npm run sync-all` (or `pnpm run sync-all`, etc.).
45
+ - Start the dev server: `npm run dev` (or your package manager’s equivalent).
40
46
 
41
- See the project's `README.md` for full details.
47
+ See the project’s `README.md` for full details.
42
48
 
43
49
  ## Publishing to npm
44
50
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-appraise",
3
- "version": "0.1.4",
3
+ "version": "0.1.5",
4
4
  "description": "Scaffold a new Appraise app in your directory",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Hasnat Jamil",