You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 22, 2025. It is now read-only.
<p align="center">A CLI to quickly start a project with your favourite framework, already set up with <a href="http://www.storyblok.com?utm_source=github.com&utm_medium=readme&utm_campaign=create-storyblok-app" target="_blank">Storyblok</a>, Headless CMS.</p> <br />
<p align="center">A CLI to quickly start a project with your favorite framework, already set up with <a href="http://www.storyblok.com?utm_source=github.com&utm_medium=readme&utm_campaign=create-storyblok-app" target="_blank">Storyblok</a>, Headless CMS.</p> <br />
2. Create a new space and retrieve the space preview token under Space -> Settings -> Api Keys
39
-
3. Execute follwing command with the space preview access token:
43
+
1. Signup at https://app.storyblok.com/;
44
+
2. Create a new space and retrieve the space preview token under your space in "Settings -> Access Tokens" menu item;
45
+
3. Execute the following commands (use your preview access token when prompted when running the `npx` command):
40
46
41
-
```sh-session
47
+
~~~bash
42
48
npx @storyblok/create-demo@latest
43
49
44
50
cd my-app
45
51
npm i && npm run dev
46
-
```
52
+
~~~
47
53
48
-
4. Open the Storyblok editor and directly edit your content locally: http://localhost:3000/editor.html
54
+
4. Open the Storyblok App following the URL suggested by the output provided by the commands. It depends on the HTTPS configuration and the port used by the frameworks.
49
55
50
56
# CLI Options
51
57
52
-
The CLI has different options that can be filled, you can see all the options by running `npx @storyblok/create-demo --help`:
58
+
The CLI has different options that can be filled, you can see all the options by running `npx @storyblok/create-demo --help`:
53
59
54
-
```
60
+
~~~
55
61
OPTIONS
56
62
-d, --folder=folder Folder path for the demo (e.g. my-demo)
57
63
-f, --framework=framework Framework to use (e.g. remix)
58
64
-h, --help show CLI help
59
65
-k, --key=key Storyblok Access Token
60
-
-l, --localmode using the local mode
61
66
-p, --packagemanager=packagemanager Package manager to use (yarn or npm)
62
-
-r, --region=region Space region (e.g. us-east-1)
67
+
-r, --region=region Space region (EU, US). The support for the China region will be introduced in the next release.
63
68
-v, --version show CLI version
64
-
```
69
+
~~~
65
70
66
-
By using this you can skip the "questions" of the CLI and fill it with your options directly like so:
71
+
By using this, you can skip the "questions" of the CLI and fill it with your options directly like so:
npx @storyblok/create-demo@latest --key YOUR_STORYBLOK_PREVIEW_TOKEN --region US
75
+
~~~
71
76
72
77
73
78
### Local Development
74
79
75
-
If you want to contribute you can run the CLI locally and test it with this command:
80
+
If you want to contribute, you can run the CLI locally and test it with this command:
76
81
77
-
```sh-session
82
+
~~~bash
78
83
npm i
79
-
./bin/run --key YOUR_STORYBLOK_PREVIEW_TOKEN
80
-
```
84
+
./bin/dev --key YOUR_STORYBLOK_PREVIEW_TOKEN
85
+
~~~
81
86
82
87
#### Framework Options
83
88
84
-
The framework options can be set in `src/frameworks.js` and work in combination with the [getting-started](https://github.com/storyblok/getting-started)repository
89
+
The framework options can be set in `src/lib/frameworks.ts` and work in combination with the [getting-started](https://github.com/storyblok/getting-started)or The Ultimate Tutorial repositories:
85
90
86
91
-`name`: name of the framework
87
92
-`value`: cli value to use for reference
@@ -90,9 +95,9 @@ The framework options can be set in `src/frameworks.js` and work in combination
90
95
-`config`: file that has the access token
91
96
-`bridge`: file that is loading the bridge
92
97
-`public`: public folder path for the static files
93
-
-`port`: port the framework starts,
94
-
-`branch`: (optional) for testing other branches on the `getting-started` repository
98
+
-`port`: port the framework starts,
99
+
-`repositoryUrl`: (optional) the URL repository for cloning the template;
100
+
-`branch`: (optional) for setting a specific branches
95
101
-`https`: (optional) if the framework starts with https
96
102
-`submodules`: (optional) if the framework in `getting-started` is a submodule
97
103
-`tutorialLink`: (optional) - link to the framwork tutorial
0 commit comments