Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(story): restructure story starter #80

Merged
merged 7 commits into from
Aug 13, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions space-plugins/story-starter/.gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
# Nuxt dev/build outputs
.output
.data
.nuxt
.nitro
.cache
dist

# Node dependencies
node_modules

# Logs
logs
*.log

# Misc
.DS_Store
.fleet
.idea

# Local env files
.env
.env.*
!.env.example


.idea
**/node_modules
18 changes: 11 additions & 7 deletions space-plugins/story-starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

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]
Expand All @@ -15,10 +25,4 @@ To learn more about the configuration, read the [space-plugin-nuxt-starter's REA

## 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.
Binary file removed space-plugins/story-starter/docs/deploy-subdir.png
Binary file not shown.
Binary file added space-plugins/story-starter/docs/screenshot1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added space-plugins/story-starter/docs/screenshot2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 33 additions & 8 deletions space-plugins/story-starter/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,39 @@
{
"name": "story-starter",
"version": "0.0.1",
"description": "",
"name": "story-starter",
"private": true,
"workspaces": [
"starters/*"
],
"type": "module",
"scripts": {
"dev:nuxt": "pnpm -F nuxt dev"
"build": "nuxt build",
"dev": "nuxt dev",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"generate": "nuxt generate",
"preview": "nuxt preview",
"postinstall": "nuxt prepare"
},
"dependencies": {
"@storyblok/app-extension-auth": "2.0.0",
"@storyblok/region-helper": "^1.1.0",
"@types/nprogress": "^0.2.3",
"nprogress": "^0.2.0",
"storyblok-js-client": "^6.2.0",
"valibot": "^0.19.0"
},
"author": "",
"license": "MIT"
"devDependencies": {
"@nuxt/devtools": "latest",
"@nuxt/eslint-config": "^0.2.0",
"@nuxtjs/google-fonts": "3.1.0",
"@nuxtjs/tailwindcss": "^6.11.0",
"autoprefixer": "10.4.16",
"daisyui": "^4.4.19",
"eslint": "^8.56.0",
"eslint-plugin-vuejs-accessibility": "^2.2.1",
"h3": "^1.8.2",
"just-debounce-it": "3.2.0",
"nuxt": "3.11.1",
"nuxt-lucide-icons": "1.0.5",
"vue": "^3.4.14",
"vue-router": "^4.2.5"
}
}
Loading