https://github.com/geometricpanda/ng-storyblok
Angular support for the Storyblok API
https://github.com/geometricpanda/ng-storyblok
Last synced: 2 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 (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-10T07:38:02.000Z (8 months ago)
- Last Synced: 2025-03-15T16:37:14.313Z (2 months ago)
- Language: TypeScript
- Size: 2.65 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-angular - ng-storyblok - A simple way to integrate [Storyblok](https://www.storyblok.com/) into your Angular application. (Table of contents / Angular)
- fucking-awesome-angular - ng-storyblok - A simple way to integrate 🌎 [Storyblok](www.storyblok.com/) into your Angular application. (Table of contents / Angular)
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