Skip to content

Commit

Permalink
fix(story): restructure story starter (#80)
Browse files Browse the repository at this point in the history
* fix(story): restructure story starter

* update README

* update README

* Update README.md

* Update README.md
  • Loading branch information
eunjae-lee authored Aug 13, 2024
1 parent cef1892 commit 47968ff
Show file tree
Hide file tree
Showing 43 changed files with 5,966 additions and 10,875 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,7 @@ logs
.env
.env.*
!.env.example


.idea
**/node_modules
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,27 @@

The Story Starter is a [Space Plugin](https://www.storyblok.com/docs/plugins/custom-application) template that appears on the sidebar of your Storyblok space. It offers essential features for retrieving stories, enabling users to select specific ones, and performing actions. You can implement the actions you want to perform in `stories.config.ts`.

<p align="center">
<img src="./docs/screenshot1.png" alt="Screenshot 1" width="600" />
</p>
<p align="center">(↑ Story Starter)</p>

<p align="center">
<img src="./docs/screenshot2.png" alt="Screenshot 2" width="600" />
</p>
<p align="center">(↑ You can define actions like "Delete" in <code>stories.config.ts</code>)</p>

## Getting Started

> [!NOTE]
> Currently, the Story Starter is written only in Nuxt. However, please inform us if you would like to have a Next.js version. Feel free to create a GitHub issue to make the request.
```sh
npx giget@latest gh:storyblok/space-tool-plugins/space-plugins/story-starter YOUR-PROJECT-NAME
npx giget@latest gh:storyblok/space-tool-plugins/space-plugins/nuxt-story-starter YOUR-PROJECT-NAME
```

To learn more about the configuration, read the [space-plugin-nuxt-starter's README](https://github.com/storyblok/space-tool-plugins/blob/main/space-plugin-nuxt-starter/README.md#configuration).

## Customization

Open the `starters/nuxt/stories.config.ts` file and implement your own actions. You can refer to the existing sample implementation for guidance.

## Deployment

The Story Starter is set up as a monorepo, and most hosting platforms support it seamlessly. For instance, Vercel recognizes it as a Nuxt project and automatically configures the root directory for you.

<img src="./docs/deploy-subdir.png" alt="Vercel Deployment" width="600" />
Open the `stories.config.ts` file and implement your own actions. You can refer to the existing sample implementation for guidance.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"version": "0.0.1",
"name": "nuxt",
"name": "nuxt-story-starter",
"private": true,
"type": "module",
"scripts": {
"build": "nuxt build",
"dev": "nuxt dev --dotenv ../../.env",
"dev": "nuxt dev",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"generate": "nuxt generate",
Expand All @@ -31,9 +31,9 @@
"eslint-plugin-vuejs-accessibility": "^2.2.1",
"h3": "^1.8.2",
"just-debounce-it": "3.2.0",
"nuxt": "^3.8.0",
"nuxt-lucide-icons": "1.0.3",
"vue": "^3.3.4",
"nuxt": "3.11.1",
"nuxt-lucide-icons": "1.0.5",
"vue": "^3.4.14",
"vue-router": "^4.2.5"
}
}
Loading

0 comments on commit 47968ff

Please sign in to comment.