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

docs(tool-nuxt): update README #77

Merged
Merged
Show file tree
Hide file tree
Changes from all 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
8 changes: 1 addition & 7 deletions space-plugins/nuxt-starter/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `space-plugin-nuxt-starter`

This Nuxt starter is a Storyblok Space Plugin app that includes the basic authentication flow.
This Nuxt starter is a Storyblok Space Plugin that includes the basic authentication flow.

## Tutorial Video

Expand Down Expand Up @@ -73,12 +73,6 @@ export default defineAppConfig({
oauth: true,
origin: 'https://app.storyblok.com',
},
auth: {
endpointPrefix: '/api/connect',
initOauthFlowUrl: `/api/connect/storyblok`,
successCallback: '/',
errorCallback: '/401',
},
});
```

Expand Down
20 changes: 3 additions & 17 deletions tool-plugins/nuxt-starter/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
# `space-plugin-nuxt-starter`
# `tool-plugin-nuxt-starter`

This Nuxt starter is a Storyblok Space Plugin app that includes the basic authentication flow.

## Tutorial Video

If you prefer video tutorials over text, this is for you:

https://www.loom.com/share/f56defc5bfcf4fa8bce8682386f8352b?sid=8820f1b2-4229-4b05-9f22-4855e6dfccc5
This Nuxt starter is a Storyblok Tool Plugin that includes the basic authentication flow.

## Getting Started

```sh
npx giget@latest gh:storyblok/space-tool-plugins/space-plugins/nuxt-starter YOUR-PROJECT-NAME
npx giget@latest gh:storyblok/space-tool-plugins/tool-plugins/nuxt-starter YOUR-PROJECT-NAME
```

This repository is developed using [pnpm](https://pnpm.io/). However, you can also use Yarn or NPM.
Expand Down Expand Up @@ -73,12 +67,6 @@ export default defineAppConfig({
oauth: true,
origin: 'https://app.storyblok.com',
},
auth: {
endpointPrefix: '/api/connect',
initOauthFlowUrl: `/api/connect/storyblok`,
successCallback: '/',
errorCallback: '/401',
},
});
```

Expand All @@ -88,8 +76,6 @@ export default defineAppConfig({

7. Start developing by running `yarn dev`, and open it on Storyblok.

<img src="./docs/open-extension.png" alt="Open the extension" width="200" />

> [!NOTE]
> If the authentication flow isn't working, please check if you have an ad blocker extension enabled in your browser and disable it.

Expand Down
Binary file modified tool-plugins/nuxt-starter/docs/new-extensions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.