@quickdapp/cli 3.9.1 → 3.10.1
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.
- package/README.md +13 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @quickdapp/cli
|
|
2
2
|
|
|
3
|
-
CLI tool to scaffold new QuickDapp projects.
|
|
3
|
+
CLI tool to scaffold new [QuickDapp](https://quickdapp.xyz) projects.
|
|
4
|
+
|
|
5
|
+
QuickDapp is a production-ready full-stack TypeScript boilerplate — authentication, PostgreSQL database, GraphQL API, background workers, and a polished React frontend — so you can skip the setup and start building. Available as a base package or with Web3 integration (wallet auth, smart contracts, chain monitoring).
|
|
4
6
|
|
|
5
7
|
## Usage
|
|
6
8
|
|
|
@@ -11,33 +13,34 @@ bunx @quickdapp/cli create my-project
|
|
|
11
13
|
# Using npx
|
|
12
14
|
npx @quickdapp/cli create my-project
|
|
13
15
|
|
|
14
|
-
#
|
|
16
|
+
# 'create' is the default command, so this also works
|
|
15
17
|
bunx @quickdapp/cli my-project
|
|
16
18
|
|
|
17
|
-
# With variant
|
|
18
|
-
bunx @quickdapp/cli create my-project --variant web3
|
|
19
|
-
bunx @quickdapp/cli create my-project --variant base # Base (default)
|
|
19
|
+
# With Web3 variant
|
|
20
|
+
bunx @quickdapp/cli create my-project --variant web3
|
|
20
21
|
```
|
|
21
22
|
|
|
22
23
|
## Options
|
|
23
24
|
|
|
24
25
|
| Option | Description |
|
|
25
26
|
|--------|-------------|
|
|
26
|
-
| `-v, --variant <name>` |
|
|
27
|
+
| `-v, --variant <name>` | Project variant: `base` or `web3` (default: `base`) |
|
|
27
28
|
| `--skip-install` | Skip running `bun install` after scaffolding |
|
|
28
29
|
| `-r, --release <version>` | Use a specific release version |
|
|
29
30
|
| `--list-versions` | List available QuickDapp versions |
|
|
31
|
+
| `--version` | Show CLI version |
|
|
30
32
|
| `--help` | Show help |
|
|
31
33
|
|
|
32
34
|
## Prerequisites
|
|
33
35
|
|
|
34
36
|
- [Git](https://git-scm.com/)
|
|
35
|
-
- [Bun](https://bun.sh/)
|
|
37
|
+
- [Bun](https://bun.sh/)
|
|
38
|
+
- [Docker](https://docker.com/)
|
|
36
39
|
|
|
37
40
|
## Documentation
|
|
38
41
|
|
|
39
|
-
See [
|
|
42
|
+
See the [CLI documentation](https://quickdapp.xyz/docs/getting-started) for a full getting started guide.
|
|
40
43
|
|
|
41
44
|
## License
|
|
42
45
|
|
|
43
|
-
MIT
|
|
46
|
+
MIT — see [LICENSE.md](./LICENSE.md)
|