https://github.com/storyblok/storyblok-workflow-app
Example Storyblok app
https://github.com/storyblok/storyblok-workflow-app
dx example
Last synced: 3 months ago
JSON representation
Example Storyblok app
- Host: GitHub
- URL: https://github.com/storyblok/storyblok-workflow-app
- Owner: storyblok
- Created: 2020-05-11T13:44:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-21T23:19:36.000Z (over 2 years ago)
- Last Synced: 2024-04-14T23:59:53.424Z (over 1 year ago)
- Topics: dx, example
- Language: Vue
- Homepage:
- Size: 1000 KB
- Stars: 11
- Watchers: 8
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Storyblok Stage Kanban App
> Kanban app to change the Workflow Stage from a story
## Development
Firstly, to create an app on Storyblok, you need to enter to the [our partner program](https://www.storyblok.com/partners).
### Installation
``` bash
# clone this repository
$ git clone https://github.com/storyblok/storyblok-workflow-app.git
# Enter the directory
$ cd storyblok-workflow-app
# install dependencies
$ yarn install # npm install
```
### Configure the the Oauth2 module
To run the project in development, firstly, you need to configure our `nuxt-auth` module ([check out the documentation](https://github.com/storyblok/nuxt-auth)) with your oauth credentials (these credentials are available in the app settings area of Storyblok).
Rename the file `.env-example` to `.env` and fill out the variables.
~~~text
CONFIDENTIAL_CLIENT_ID="Id from Storyblok App"
CONFIDENTIAL_CLIENT_SECRET="Secret from Storyblok App"
CONFIDENTIAL_CLIENT_REDIRECT_URI=https://YOUR_ID.ngrok.io/auth/callback
~~~
### Setup an SSL tunnel
We recommend you to use [ngrok](https://ngrok.com/) to create a tunel to your development environment. In you terminal, execute:
```bash
$ ngrok http 3000 # the 3000 port is the Nuxt default
```
Use the urls you get from ngrok to fill out the following fields in the app settings area in Storyblok:
* `Url to your app` field: `https://YOUR_ID.ngrok.io/auth/connect/storyblok`
* `Oauth2 callback url` field: `https://YOUR_ID.ngrok.io/auth/callback` (this URL must be include in `redirect_uri` property in `nuxt-auth` module)
### Check the App in Development
After all, start the Nuxt dev server:
```bash
$ yarn dev # npm run dev
```
Now click the "Open" button in the app settings area of your app in Storyblok to install the app on a space.
### Deploy
This app is like any other Nuxt app, so, the deploy is the same ([check the Nuxt documentation about this](https://nuxtjs.org/guide/commands#production-deployment)). **The only thing that you must be concern, is the URLs configurations**.
---
Powered by Storyblok