0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

Reactライブラリ用のテンプレートを作成してみた

Posted at

こんにちは,ご覧いただきありがとうございます。
普段,Reactでフロントを作成しているのですが,個人開発なため,毎度同じようなコンポーネントを利用します。
そのため,最近はライブラリ化を行い,それぞれのコンポーネントを使いまわすようにしています。(これについては賛否両論あるかもしれませんが)
しかし,そのライブラリ化を行うにあたって,毎度同じようなリポジトリを作るのも億劫です(本当に面倒くさがりなんです)。
そこで今回,そのリポジトリをテンプレートにしちゃえということで作成しました。

テンプレートとしてリポジトリを登録しておりますので右上の「Use this template」から簡単にリポジトリをコピーできます!!
ぜひご活用ください!!

以下はリポジトリについての簡単に説明です。

前提

  • Reactのためのライブラリ
  • Storybookでコンポーネント管理
  • ビルド等はVite

ディレクトリ・ファイル等

~/.github/workflows/publish.yml

mainブランチにおいて,package.jsonが更新された際に実行されます。

  1. ビルドが行われ,npmに公開します。
  2. package.jsonversionの値から取得したリリースとそのブランチを作成します。

アクションのsecretsにNPM_TOKENnpmjs.orgで発行したトークンを登録しておいてください。

~/.github/workflows/sb-build.yml

mainブランチにおいて,/stories/*が更新された際に実行されます。

  1. yarn build-sb(Storybookのビルド)が行われます。
  2. gh-pagesにプッシュします。

gh-pagesのブランチを事前に作成してください。

~/.storybook

Storybookに関する設定等のファイルです。
Storybookについては公式サイトをご確認ください。

~/docs

Storybookのビルドファイルを格納します。
GitHub Pagesで

~/src/index.ts

このファイルにコンポーネントを定義し,exportしてください。
あるいは他のファイルのコンポーネントをimportし,exportしてください。
このファイルの内容のビルドが行われ,ライブラリとして公開されます。

~/stories

Storybookで管理するコンポーネントのストーリーファイルを作成してください。
詳細は公式サイトをご確認ください。

~/*

諸々のファイルがありますが,ここでの説明は割愛します。

0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?