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.
Copy file name to clipboardExpand all lines: README.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@
43
43
# Getting Started
44
44
45
45
1. Signup at https://app.storyblok.com/
46
-
2. Create a new space and retrieve the space preview token under Space -> Settings -> Api Keys
46
+
2. Create a new space and retrieve the space preview token under your space in "Settings -> Access Tokens" menu item
47
47
3. Execute the following commands (use your preview access token when prompted when running the `npx` command):
48
48
49
49
```sh-session
@@ -83,12 +83,12 @@ If you want to contribute you can run the CLI locally and test it with this comm
83
83
84
84
```sh-session
85
85
npm i
86
-
./bin/run --key YOUR_STORYBLOK_PREVIEW_TOKEN
86
+
./bin/dev --key YOUR_STORYBLOK_PREVIEW_TOKEN
87
87
```
88
88
89
89
#### Framework Options
90
90
91
-
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
91
+
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:
92
92
93
93
-`name`: name of the framework
94
94
-`value`: cli value to use for reference
@@ -98,7 +98,8 @@ The framework options can be set in `src/frameworks.js` and work in combination
98
98
-`bridge`: file that is loading the bridge
99
99
-`public`: public folder path for the static files
100
100
-`port`: port the framework starts,
101
-
-`branch`: (optional) for testing other branches on the `getting-started` repository
101
+
-`repositoryUrl`: (optional) the URL repository for cloning the template;
102
+
-`branch`: (optional) for setting a specific branches
102
103
-`https`: (optional) if the framework starts with https
103
104
-`submodules`: (optional) if the framework in `getting-started` is a submodule
104
105
-`tutorialLink`: (optional) - link to the framwork tutorial
0 commit comments