@jigowatts/jigowatts-ui 0.0.1-12

package/README.md

@@ -0,0 +1,50 @@
+# jigowatts_ui
+
+## ライブラリ
+パッケージの読み取りには、personal access token が必要です。
+
+https://github.com/settings/tokens/new
+
+から package:read の権限を持ったトークンを生成します。
+
+トークンは
+```
+$ export NPM_PACKAGE_TOKEN=<取得したトークン>
+```
+
+```
+> $Env:NPM_PACKAGE_TOKEN = <取得したトークン>
+```
+
+のようにして環境変数を設定します。
+
+トークンを設定したら、 
+
+```
+$ pnpm install @Jigowatts/jigowatts-ui
+```
+で導入することができます
+
+## storybook
+
+storybookによるドキュメントを生成できます。
+
+```
+$ pnpm run storybook
+```
+
+でサーバーが起動します。
+http://localhost:6006にアクセスすることでカタログを見ることができます。
+
+### Map等動かないものがある場合
+
+```
+$ pnpm run build-storybook
+```
+でstorybook-staticに必要なHTMLファイル等が生成されます。
+
+```
+$ cd ./storybook-static
+$ npx http-server .
+```
+や、vscodeのlivepreview機能を利用してhttpサーバ経由でカタログを確認することができます。