VStory

VStory integrates the underlying capabilities of VisActor to provide an out-of-the-box data narrative solution.

English | 简体中文

(Demo Video)

简介

VStory is a chart component library in the VisActor visualization system. It is based on the visualization chart library VChart, the visualization grammar library VGrammar, and the visualization rendering engine VRender for component encapsulation. The core capabilities are as follows:

1. One code for multiple platforms: Automatically adapt to desktop, H5, and multiple small program environments
2. Narrative-oriented: Comprehensive application of a series of enhanced functions such as annotation, animation, process control, narrative templates, etc. for narrative visualization creation.
3. Scene precipitation: Facing the end users to precipitate visualization capabilities, liberating the productivity of developers

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 documents, sample code, etc. on the site.

🔨 Usage

Under construction...

⌨️ Development

First, install @microsoft/rush globally:

$ npm i --global @microsoft/rush

Then clone the code to your local machine:

# clone
$ git clone [email protected]:VisActor/VStory.git
$ cd VStory
# 安装依赖
$ rush update
# 开始 vstory 的本地开发
$ rush start
# 开始站点的本地开发
$ rush docs

📖 Documents

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

# start vstory document server
$ rush start

🔗 Related Links

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

🤝 Contributing 

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

Small streams make a river, and eventually become a sea!