VStory

VStory, tell stories with data. An intelligent data narrative development framework.

English | 简体中文 | 日本語

(Demo Video)

Introduction

VStory is a narrative visualization development framework in the VisActor visualization system. It encapsulates components based on the visualization chart library VChart, visualization grammar library VGrammar, and visualization rendering engine VRender. Core capabilities include:

1. Cross-platform Compatibility: Automatically adapts to desktop, H5, and multiple mini-program environments
2. Narrative-oriented: Creates narrative visualizations by comprehensively applying enhanced features such as annotations, animations, process control, and narrative templates
3. Scene Accumulation: Accumulates narrative visualization capabilities for data dashboards, infographics, data videos, data reports, and other scenarios, liberating developer productivity

Repository Introduction

This repository contains the following packages:

1. vstory: Core package, VStory editor
2. docs: VStory site source code, including all Chinese and English documentation, example code, and other content on the site.

🔨 Demo

Demo

⌨️ Development

First, install @microsoft/rush globally:

$ npm i --global @microsoft/rush

Then clone the code locally:

# clone
$ git clone [email protected]:VisActor/VStory.git
$ cd VStory
# install dependencies
$ rush update
# start local development of vstory
$ rush start
# start local development of the site
$ rush docs

📖 Documents

After installing and updating dependencies, you can execute the docs command to start local document preview for vstory:

# start vstory document server
$ rush start

🔗 Related Links

• VCharts Examples
• VChart Tutorial
• VChart Configuration
• VChart API
• VGrammar
• VRender

🤝 Contributing

If you would like to contribute, please read our Code of Conduct and Contributing Guidelines.

Small streams form rivers, eventually becoming the sea!