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