Skip to content

Commit

Permalink
remove unused config
Browse files Browse the repository at this point in the history
  • Loading branch information
eunjae-lee committed Jan 31, 2024
1 parent 462dab8 commit bd7fce5
Show file tree
Hide file tree
Showing 9 changed files with 1 addition and 119 deletions.
62 changes: 0 additions & 62 deletions space-plugin-nuxt-base/stories.config.ts

This file was deleted.

58 changes: 1 addition & 57 deletions story-starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,60 +11,4 @@ The Story Starter is a [Space Plugin](https://www.storyblok.com/docs/plugins/cus
npx giget@latest gh:storyblok/space-tool-plugins/story-starter YOUR-PROJECT-NAME
```

This repository is developed using [pnpm](https://pnpm.io/). However, you can also use Yarn or NPM.

```sh
cd YOUR-PROJECT-NAME

pnpm install && pnpm run dev:nuxt
# or
yarn install && yarn run dev:nuxt
# or
npm install && npm run dev:nuxt
```

## Configuration

You need to create a Storyblok extension that will provide you with OAuth credentials. Then, you should add this information to your `.env` file and your hosting platform.

1. You can find the "Extensions" menu under either the Partner Portal or the My Organization.

<img src="./assets/storyblok-extensions.png" alt="Storyblok Extensions" width="200" />

2. Click the "New Extension" button in the top right corner and enter the necessary information.

<img src="./assets/new-extensions.png" alt="New Extension" width="600" />

And then you can find the information.

<img src="./assets/oauth.png" alt="OAuth information" width="600" />

3. Configure the following environment variables in `<ROOT-OF-YOUR-PROJECT>/starters/nuxt/.env`.

- `CLIENT_ID=`: Client Identifer
- `CLIENT_SECRET=`: Client Secret
- `BASE_URL=`: When using this starter, you should expose your local development server. To do this, we suggest using services like [ngrok](https://ngrok.com/). Let's say your hostname is `https://PUT-YOURS.ngrok.io`. Set that as your `BASE_URL`.

4. Configure your extension on Storyblok with the index URL and the redirection URL. The redirection URL ends with `/api/connect/callback`.

<img src="./assets/urls-for-oauth.png" alt="Configure URLs for oauth" width="300" />

Ensure that "Production" is the section that contains information about the production deployment, while "Preview" refers to your development environment, such as exposing localhost through ngrok.

5. Open the "Install Link" in a new tab and install it in your space for the development and test.

<img src="./assets/install-link.png" alt="Install Link" width="600" />

6. Start developing by running `yarn dev:nuxt`, and open it on Storyblok.

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

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

8. Deploying

The 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="./assets/deploy-subdir.png" alt="Vercel Deployment" width="600" />

You should configure the same environment variables on the hosting platform as well.
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).
Binary file removed story-starter/assets/deploy-subdir.png
Binary file not shown.
Binary file removed story-starter/assets/install-link.png
Binary file not shown.
Binary file removed story-starter/assets/new-extensions.png
Binary file not shown.
Binary file removed story-starter/assets/oauth.png
Binary file not shown.
Binary file removed story-starter/assets/open-extension.png
Binary file not shown.
Binary file removed story-starter/assets/storyblok-extensions.png
Binary file not shown.
Binary file removed story-starter/assets/urls-for-oauth.png
Binary file not shown.

0 comments on commit bd7fce5

Please sign in to comment.