VStory
VStory integrates the underlying capabilities of VisActor to provide an out-of-the-box data narrative solution.
[English](./README.md) | 简体ä¸æ–‡ | [日本語](./README.ja-JP.md)
(Demo Video)
## 简介
VStory is a chart component library in the VisActor visualization system. It is based on the visualization chart library [VChart](https://github.com/VisActor/VChart), the visualization grammar library [VGrammar](https://github.com/VisActor/VGrammar), and the visualization rendering engine [VRender](https://github.com/VisActor/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`](./packages/vstory/): Core package, VStory editor
2. [`docs`](./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](https://rushjs.io/pages/intro/get_started/) globally:
```bash
$ npm i --global @microsoft/rush
```
Then clone the code to your local machine:
```bash
# 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:
```bash
# start vstory document server
$ rush start
```
## 🔗 Related Links
- [VCharts Chart Examples](https://www.visactor.io/vchart/example)
- [VChart Chart Tutorial](https://www.visactor.io/vchart/guide/tutorial_docs/VChart_Website_Guide)
- [VChart Chart Configuration Items](https://www.visactor.io/vchart/option/)
- [VChart API](https://www.visactor.io/vchart/api/API/vchart)
- [VGrammar](https://www.visactor.io/vgrammar)
- [VRender](https://www.visactor.io/vrender)
## 🤠Contributing [](https://github.com/VisActor/VChart/blob/main/CONTRIBUTING.md#your-first-pull-request)
If you would like to contribute, please read the [Code of Conduct](https://sophon-ai.bytedance.net/paas/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://sophon-ai.bytedance.net/paas/CONTRIBUTING.md).
Small streams make a river, and eventually become a sea!
