apache/echarts:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく apache/echarts の導入と確認ガイドです。
プロジェクトの範囲
apache/echarts の README はプロジェクトを「Apache ECharts is a powerful, interactive charting and data visualization library for browser」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「Apache ECharts」には次の説明があります。Apache ECharts is a free, powerful charting and visualization library offering easy ways to add intuitive, interactive, and highly customizable charts to your commercial products.。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「Get Help」にある内容から、用途が合うかを先に判断できます。Email dev@echarts.apache.org for general questions。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。GitHub Issues for bug report and feature requests。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「Build」など複数の箇所に分かれています。確認できる情報は次の通りです。Then the "production" files are generated in the dist directory.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 # Install the dependencies from NPM: npm install # Rebuild source code immediately in watch mode when changing the source code. # It opens the `./test` directory, and you may open `-cases.html` to get the list # of all test cases. # If you wish to create a test case, run `npm run mktest:help` to learn more. npm run dev # Check the correctness of TypeScript code. npm run checktype # If intending to build and get all types of the "production" files: npm run release 実行可能なコマンドがない場合は手順を作らず、「Get Apache ECharts」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「Contribution」にはPlease refer to the contributing document if you wish to debug locally or make pull requests.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはSubscribe to the mailing list to get updated with the projectともあります。