search

ramp4-pcar4 / story-ramp

Storytelling with interactive maps using RAMP
MIT License
4 stars 13 forks source link

Add storylines plugin build #376

Closed yileifeng closed 11 months ago

yileifeng commented 1 year ago

Closes #347 (separate PR for editor repo later)

Adds initial support for building project as a Vue plugin and is published to NPM: https://www.npmjs.com/package/ramp-storylines. Will need to add proper README documentation after, created issue https://github.com/ramp4-pcar4/story-ramp/issues/368.

Building the project as a plugin is done by: npm run build-plugin and the dist folder contents is published as a package, with storylines-viewer.umd.min serving as the main entry point.

Currently, the story-content, intro and chart components are exposed as the usable components when integrating the plugin into other projects. May need to update this build configuration later (pending any issues integrating the plugin into the marketing site or other future requirements), but it works well with the editor repo when I tested.

This change is Reviewable

github-actions[bot] commented 1 year ago

Your demo site is ready! 🚀 Visit it here: https://ramp4-pcar4.github.io/story-ramp/storylines-plugin-build/#/en/00000000-0000-0000-0000-000000000000