@valbuild/create 0.87.3 → 0.87.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.
- package/README.md +4 -41
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -1,52 +1,15 @@
|
|
|
1
1
|
# @valbuild/create
|
|
2
2
|
|
|
3
|
-
Bootstrap a Val project from the
|
|
3
|
+
Bootstrap a Val project from the CLI.
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
8
|
npm create @valbuild@latest
|
|
9
|
-
# or with a project name
|
|
10
|
-
npm create @valbuild@latest my-val-app
|
|
11
9
|
```
|
|
12
10
|
|
|
13
|
-
|
|
11
|
+
## Next steps
|
|
14
12
|
|
|
15
|
-
|
|
13
|
+
Read the docs here: https://val.build/docs
|
|
16
14
|
|
|
17
|
-
-
|
|
18
|
-
- `-v`, `--version` Show version
|
|
19
|
-
- `--root <path>` Specify the root directory for project creation (default: current directory)
|
|
20
|
-
|
|
21
|
-
## Templates
|
|
22
|
-
|
|
23
|
-
- **starter**: Full-featured Next.js app with Val, TypeScript, Tailwind CSS, and examples
|
|
24
|
-
- **minimal**: Minimal Next.js app with Val and TypeScript
|
|
25
|
-
|
|
26
|
-
## Adding More Templates
|
|
27
|
-
|
|
28
|
-
To add more templates:
|
|
29
|
-
|
|
30
|
-
1. **Create a new public GitHub repo** under the `valbuild` org (e.g. `valbuild/template-nextjs-ecommerce`).
|
|
31
|
-
2. Add your template code to that repo.
|
|
32
|
-
3. In this CLI, open `src/index.ts` and add your template to the `TEMPLATES` array:
|
|
33
|
-
|
|
34
|
-
```ts
|
|
35
|
-
{
|
|
36
|
-
name: "ecommerce",
|
|
37
|
-
description: "E-commerce starter with Val and Next.js",
|
|
38
|
-
repo: "valbuild/template-nextjs-ecommerce"
|
|
39
|
-
}
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
4. (Optional) Publish your template repo with a clear README and keep it up to date.
|
|
43
|
-
|
|
44
|
-
## Contributing
|
|
45
|
-
|
|
46
|
-
- PRs for new templates, bugfixes, or UX improvements are welcome!
|
|
47
|
-
- Please keep template names and descriptions clear and future-proof.
|
|
48
|
-
- For major changes, open an issue to discuss your idea first.
|
|
49
|
-
|
|
50
|
-
## License
|
|
51
|
-
|
|
52
|
-
MIT
|
|
15
|
+
If you wish want to make it possible for non-technical editors to use Val directly in your application, you can create a project here: https://admin.val.build
|
package/package.json
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@valbuild/create",
|
|
3
|
-
"version": "0.87.
|
|
3
|
+
"version": "0.87.5",
|
|
4
4
|
"description": "Create a new Val project with Next.js",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/valbuild/val.git"
|
|
8
|
+
},
|
|
5
9
|
"main": "dist/valbuild-create.cjs.js",
|
|
6
10
|
"module": "dist/valbuild-create.esm.js",
|
|
7
11
|
"bin": {
|