Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/visactor/vstory
A narrative visualization framework
https://github.com/visactor/vstory
charts data-video data-visualization diagram gis graphs infographics llm narrative-visualization tables
Last synced: 1 day ago
JSON representation
A narrative visualization framework
- Host: GitHub
- URL: https://github.com/visactor/vstory
- Owner: VisActor
- License: mit
- Created: 2024-05-27T03:57:06.000Z (6 months ago)
- Default Branch: develop
- Last Pushed: 2024-10-24T06:37:49.000Z (21 days ago)
- Last Synced: 2024-10-25T01:46:43.543Z (21 days ago)
- Topics: charts, data-video, data-visualization, diagram, gis, graphs, infographics, llm, narrative-visualization, tables
- Language: TypeScript
- Homepage: https://www.visactor.io/vstory
- Size: 47 MB
- Stars: 7
- Watchers: 11
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.ja-JP.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
VStory
VStoryは、VisActorの基盤機能を統合し、すぐに使えるデータナラティブソリューションを提供します。
[English](./README.md) | 简体中文 | 日本語
（デモビデオ）
## 概要
VStoryは、VisActorの可視化システムにおけるチャートコンポーネントライブラリです。可視化チャートライブラリ[VChart](https://github.com/VisActor/VChart)、可視化文法ライブラリ[VGrammar](https://github.com/VisActor/VGrammar)、および可視化レンダリングエンジン[VRender](https://github.com/VisActor/VRender)に基づいてコンポーネントをカプセル化しています。主な機能は以下の通りです：
1. **一つのコードで複数のプラットフォームに対応**：デスクトップ、H5、および複数の小プログラム環境に自動適応
2. **ナラティブ指向**：注釈、アニメーション、プロセス制御、ナラティブテンプレートなどの一連の強化機能を総合的に適用してナラティブ可視化を作成
3. **シーンの蓄積**：最終ユーザーに向けて可視化機能を蓄積し、開発者の生産性を解放
## リポジトリの紹介
このリポジトリには以下のパッケージが含まれています：
1. [`vstory`](./packages/vstory/): コアパッケージ、VStoryエディター
2. [`docs`](./docs/): VStoryサイトのソースコード、サイト上のすべての日本語および英語のドキュメント、サンプルコードなどを含む。
## 🔨 使用方法
構築中...
## ⌨️ 開発
まず、[@microsoft/rush](https://rushjs.io/pages/intro/get_started/)をグローバルにインストールします：
```bash
$ npm i --global @microsoft/rush
```
次に、コードをローカルにクローンします：
```bash
# クローン
$ git clone [email protected]:VisActor/VStory.git
$ cd VStory
# 依存関係をインストール
$ rush update
# vstoryのローカル開発を開始
$ rush start
# サイトのローカル開発を開始
$ rush docs
```
## 📖 ドキュメント
依存関係をインストールして更新した後、docsコマンドを実行してvstoryのローカルドキュメントプレビューを開始できます：
```bash
# vstoryドキュメントサーバーを開始
$ rush start
```
## 🔗 関連リンク
- [VCharts チャート例](https://www.visactor.io/vchart/example)
- [VChart チャートチュートリアル](https://www.visactor.io/vchart/guide/tutorial_docs/VChart_Website_Guide)
- [VChart チャート設定項目](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)
## 🤝 貢献 [](https://github.com/VisActor/VChart/blob/main/CONTRIBUTING.md#your-first-pull-request)
貢献したい場合は、[行動規範](https://sophon-ai.bytedance.net/paas/CODE_OF_CONDUCT.md)および[貢献ガイドライン](https://sophon-ai.bytedance.net/paas/CONTRIBUTING.md)をお読みください。
小さな流れが川となり、最終的には海となる！