https://github.com/geometricpanda/ng-storyblok

Angular support for the Storyblok API
https://github.com/geometricpanda/ng-storyblok

Last synced: 3 months ago
JSON representation

Angular support for the Storyblok API

• Host: GitHub
• URL: https://github.com/geometricpanda/ng-storyblok
• Owner: geometricpanda
• Created: 2024-02-08T17:59:20.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-10-10T07:38:02.000Z (4 months ago)
• Last Synced: 2024-10-10T09:51:39.671Z (4 months ago)
• Language: TypeScript
• Size: 2.65 MB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NG Storyblok

The purpose of this library is to offer a simple way to integrate Storyblok into your Angular application.

## Config

### tsconfig.json

Update your `tsconfig.json` to include the `dom.iterable` lib.

This is required as `ng-storyblok` uses the `storyblok-js-client`.

```json

// tsconfig.json

{

...

    compilerOptions: {

        lib: [

            "es2020",

            "dom",

            "dom.iterable" // <-- Required due to upstream types

        ]

    }

...

}

```

## Using Preview on localhost

You'll need to create a localhost SSL key: see https://www.storyblok.com/faq/setup-dev-server-https-proxy

then update your `angular.json` (or `project.json`) serve schematic to include:

```json

// angular.json

    "options": {

        "ssl": true,

        "sslCert": "./localhost.pem",

        "sslKey": "./localhost-key.pem"

    },

```

## TODO

- [] refactor bridge to be tree-shakeable

- [] write custom renderer for storyblok rich text which supports components maybe?

- [] write schematic to generate routesfile