create-awesome-node-app 0.4.24 → 0.4.26
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 +36 -6
- package/dist/index.cjs +681 -2455
- package/dist/index.js +681 -2455
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -19,32 +19,62 @@
|
|
|
19
19
|
|
|
20
20
|
To use `create-awesome-node-app`, you need to have the following requirements:
|
|
21
21
|
|
|
22
|
-
- **Node.js
|
|
22
|
+
- **Node.js 22**: We recommend using [`fnm`](https://github.com/Schniz/fnm) to manage your Node.js versions. Install `fnm` and set the Node.js version to the latest 22 version:
|
|
23
23
|
|
|
24
24
|
```sh
|
|
25
|
-
fnm use
|
|
25
|
+
fnm use 22
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## 📦 Installation
|
|
29
|
+
|
|
30
|
+
You can install `create-awesome-node-app` globally to use it as a CLI tool:
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
npm install -g create-awesome-node-app
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Alternatively, you can use it without global installation by running it directly with `npx`, `yarn`, or `pnpm`.
|
|
37
|
+
|
|
38
|
+
## 🌟 Creating an App
|
|
39
|
+
|
|
40
|
+
### Using NPM, Yarn, or PNPM
|
|
29
41
|
|
|
30
42
|
- With NPM:
|
|
31
43
|
|
|
32
44
|
```sh
|
|
33
|
-
npm create awesome-node-app@latest
|
|
45
|
+
npm create awesome-node-app@latest --interactive
|
|
34
46
|
```
|
|
35
47
|
|
|
36
48
|
- With Yarn:
|
|
37
49
|
|
|
38
50
|
```sh
|
|
39
|
-
yarn create awesome-node-app
|
|
51
|
+
yarn create awesome-node-app --interactive
|
|
40
52
|
```
|
|
41
53
|
|
|
42
54
|
- With PNPM:
|
|
43
55
|
|
|
44
56
|
```sh
|
|
45
|
-
pnpm create awesome-node-app
|
|
57
|
+
pnpm create awesome-node-app --interactive
|
|
46
58
|
```
|
|
47
59
|
|
|
60
|
+
### Using the CLI Directly
|
|
61
|
+
|
|
62
|
+
If you installed `create-awesome-node-app` globally, you can use it directly as a CLI tool:
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
create-awesome-node-app --template react-vite-boilerplate --addons jotai material-ui github-setup
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
This example uses the `react-vite-boilerplate` template and applies the `jotai`, `material-ui`, and `github-setup` extensions.
|
|
69
|
+
|
|
70
|
+
## 🔗 Full List of Templates and Extensions
|
|
71
|
+
|
|
72
|
+
You can find the full list of available templates and extensions in the [cna-templates repository](https://github.com/Create-Node-App/cna-templates).
|
|
73
|
+
|
|
74
|
+
## 📜 License
|
|
75
|
+
|
|
76
|
+
This project is licensed under the [MIT License][licenseurl].
|
|
77
|
+
|
|
48
78
|
[cibadge]: https://github.com/Create-Node-App/create-node-app/actions/workflows/ci.yml/badge.svg
|
|
49
79
|
[npmversion]: https://img.shields.io/npm/v/create-awesome-node-app.svg?maxAge=2592000?style=plastic
|
|
50
80
|
[npmdownloads]: https://img.shields.io/npm/dm/create-awesome-node-app.svg?maxAge=2592000?style=plastic
|