create-kora-app 0.1.25-beta.10 → 0.1.25-beta.12

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 +24 -21
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,36 +1,39 @@
1
1
  # create-kora-app
2
2
 
3
- Scaffold a new [Kora.js](https://github.com/ehoneahobed/kora) offline-first application.
4
-
5
- ## Usage
3
+ Scaffold a new [Kora.js](https://korajs.dev) offline-first application. Kora 1.0 is in beta, so use
4
+ the `beta` tag (the `latest` tag is the older 0.x line):
6
5
 
7
6
  ```bash
8
- npx create-kora-app my-app
7
+ npx create-kora-app@beta my-app
9
8
  cd my-app
10
- pnpm install
11
9
  pnpm dev
12
10
  ```
13
11
 
12
+ The CLI asks for the platform, framework, styling, sync and package manager, then installs the
13
+ dependencies. `--yes` takes the recommended setup (`react-tailwind-sync`).
14
+
14
15
  ## Templates
15
16
 
16
- - **react-tailwind-sync** — React + Tailwind + sync server (recommended)
17
- - **react-tailwind** — React + Tailwind, local-only
18
- - **react-sync** — React + CSS + sync server
19
- - **react-basic** — React + CSS, local-only
17
+ | Framework | Templates |
18
+ |-----------|-----------|
19
+ | React | `react-basic`, `react-sync`, `react-tailwind`, `react-tailwind-sync` |
20
+ | Vue | `vue-basic`, `vue-sync`, `vue-tailwind`, `vue-tailwind-sync` |
21
+ | Svelte | `svelte-basic`, `svelte-sync`, `svelte-tailwind`, `svelte-tailwind-sync` |
22
+ | Desktop | `tauri-react` |
20
23
 
21
24
  ## Options
22
25
 
23
- ```bash
24
- npx create-kora-app my-app --template react-tailwind-sync --pm pnpm
25
- ```
26
-
27
26
  | Option | Description |
28
27
  |--------|-------------|
29
- | `--template` | `react-tailwind-sync`, `react-tailwind`, `react-sync`, or `react-basic` |
30
- | `--pm` | Package manager: `pnpm`, `npm`, `yarn`, `bun` |
31
- | `--skip-install` | Skip dependency installation |
32
- | `--yes` / `-y` | Accept recommended defaults |
33
- | `--tailwind` / `--no-tailwind` | Choose Tailwind styling |
34
- | `--sync` / `--no-sync` | Choose sync-enabled template |
35
-
36
- See the [full documentation](https://github.com/ehoneahobed/kora) for guides, API reference, and examples.
28
+ | `--template <id>` | Use a template directly. |
29
+ | `--platform web\|desktop-tauri` | Web or Tauri desktop. |
30
+ | `--framework react\|vue\|svelte` | UI framework. |
31
+ | `--tailwind` / `--no-tailwind` | Tailwind CSS or plain CSS. |
32
+ | `--sync` / `--no-sync` | Include a sync server. |
33
+ | `--db sqlite\|postgres`, `--db-provider <name>` | Database of the sync server. |
34
+ | `--pm pnpm\|npm\|yarn\|bun` | Package manager. |
35
+ | `--yes`, `-y` | Accept the defaults. |
36
+ | `--skip-install` | Do not install dependencies. |
37
+
38
+ See [Getting Started](https://korajs.dev/getting-started) and the
39
+ [CLI reference](https://korajs.dev/api/cli).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-kora-app",
3
- "version": "0.1.25-beta.10",
3
+ "version": "0.1.25-beta.12",
4
4
  "description": "Create a new Kora.js offline-first application",
5
5
  "type": "module",
6
6
  "bin": {
@@ -10,7 +10,7 @@
10
10
  "bin.js"
11
11
  ],
12
12
  "dependencies": {
13
- "@korajs/cli": "1.0.0-beta.11"
13
+ "@korajs/cli": "1.0.0-beta.13"
14
14
  },
15
15
  "license": "MIT"
16
16
  }