Charticulator は、対話的に制約を指定してグラフを設計できる新しいグラフ作成ツールです。
東豪仁
イ・ボンシン
マシュー・ブレマー
ネイサン・エヴァンス
ケイト・リトヴィネッツ
デビッド・ティッツワース
クリス・トレビーノ
開発環境を準備するには、次の手順に従います。
nodejs 8.0以降をインストールします: https://nodejs.org/
Yarnjs 1.7以降をインストールします: https://yarnpkg.com/
ノードモジュールをインストールします。
糸
テンプレート構成ファイルをコピーし、その内容を編集します。
cp config.template.yml config.yml# (Windows では、cp の代わりに copy を使用します)
次のコマンドを実行して Charticulator をビルドします。これにより、 distフォルダーに自己完結型のバンドルが作成されます。
糸の構築
ローカル Web サーバーを実行して Charticulator をテストします。
# http://localhost:4000yarn サーバーで Charticulator を提供します# http://0.0.0.0:4000 で公的に Charticulator を提供します# 別のコンピューターからのアクセスを有効にする場合はこれを使用しますyarn public_server
ライブ開発環境の場合は、次のコマンドを実行したままにしてください。
糸のスタート
このコマンドは、 src/およびsass/の変更を監視し、Charticulator を自動的に再コンパイルします。これが完了したら、http://localhost:4000/ を開いて Charticulator を起動します。ソース コードを変更する場合、ブラウザ ページを更新するだけでアプリを更新できるようになりました (ブラウザ キャッシュを無効にする必要がある場合があります)。
開発モードでは、UI コンポーネントのテスト アプリケーションがあり、http://localhost:4000/test.html からアクセスできます。
以下を変更しても、監視モードは更新されません。
config.yml
THIRD_PARTY.yml
webpack.config.js
これらを更新した場合は、再度yarn buildを行ってください。
Charticulator で使用できるカスタム サンプル データセットを追加できます。 これを行うには、リポジトリのルートにdatasetsフォルダーを作成し (存在しない場合)、そのフォルダーに.csv (または.tsv ) を追加し、最後に次の内容でフォルダー内にfiles.jsonファイルを作成します。コンテンツ：
[
{
"name": "<Your dataset display name>",
"description": "<Your dataset desription>",
"tables": [
{
"name": "<Your dataset file name without extension>",
"type": "<csv || tsv>",
"url": "<Your dataset file name with extension>"
}
]
}
]Charticulator には現在、基本的なテスト コードが含まれています。
糸テスト
さらに多くのテストケースが必要です。
このプロジェクトは貢献と提案を歓迎します。 ほとんどの投稿では、投稿を使用する権利をお客様が有しており、実際に当社に付与することを宣言する投稿者ライセンス契約 (CLA) に同意する必要があります。詳細については、https://cla.microsoft.com をご覧ください。
プル リクエストを送信すると、CLA ボットが CLA を提供する必要があるかどうかを自動的に判断し、PR を適切に装飾します (ラベル、コメントなど)。ボットが提供する指示に従ってください。 CLA を使用するすべてのリポジトリでこれを 1 回行うだけで済みます。
このプロジェクトはマイクロソフトのオープンソース行動規範を採用しています。詳細については、行動規範に関する FAQ を参照するか、追加の質問やコメントがあれば [email protected] までお問い合わせください。
yarn typedoc実行してドキュメント ページを生成します。このページは./docs/charticulatorで利用可能になります
ドキュメントの開始点はインデックス ページ {@link "index"} です
