Chrome拡張機能として動作するプロジェクトです。
このリポジトリは以下のテンプレートをベースに作成されています:
Jonghakseo/chrome-extension-boilerplate-react-vite (v0.4.3) Chrome 拡張機能を React + Vite + TypeScript で開発するためのボイラープレートです。
以下の手順に従って、このChrome拡張機能をローカル環境にセットアップしてください。
-
Gitがインストールされていること
-
Node.js(v16以上推奨)がインストールされていること
-
pnpmがインストールされていること
- インストールされていない場合は、
npm install -g pnpm
でインストールできます
- インストールされていない場合は、
ターミナルを開き、以下のコマンドを実行して、リポジトリをクローンします:
git clone git@github.com:jack-app/jackHack2025_A.git
クローンしたリポジトリのディレクトリに移動します:
cd jackHack2025_A
プロジェクトルートに .env
ファイルを作成し、以下のように Gemini API キーを登録してください:
CEB_API_KEY="登録した GeminiAPI key"
Gemini API キーの取得方法については、以下のドキュメントをご参照ください:
- Google Cloud Generative AI (Gemini) API キーの取得方法 サービスアカウントの作成とキー生成手順を含みます。
pnpmを使用して、必要なパッケージをインストールします:
pnpm install
以下のコマンドで開発サーバーを起動し、拡張機能をビルドします:
pnpm dev
このコマンドを実行すると:
- プロジェクトがビルドされます
dist
ディレクトリに拡張機能の実行ファイルが生成されます- ファイルの変更を監視し、変更があれば自動的に再ビルドされます
- Google Chromeを開きます
- アドレスバーに
chrome://extensions/
と入力してEnterキーを押します - 右上の「デベロッパーモード」をオンにします(トグルスイッチが右側になっていることを確認)
- 左上に表示される「パッケージ化されていない拡張機能を読み込む」ボタンをクリックします
- 表示されるダイアログで、このプロジェクトの
dist
ディレクトリを選択して「フォルダーの選択」をクリックします
これで拡張機能がChromeに読み込まれ、ツールバーに拡張機能のアイコンが表示されるはずです。
本プロジェクトは MIT License の下で公開されています。
- テンプレート提供元: Jonghakseo リポジトリ: chrome-extension-boilerplate-react-vite ライセンス: MIT License
- 上記テンプレートをベースに、構成や機能をカスタマイズして本プロジェクトを作成しています。