初めにリポジトリをクローンします。
git clone https://github.com/poporonnet/kcmsx
cd kcmsxmise を使用する場合のみ、以下の手順を追加で実行してください。自動で Node.js と bun がインストールされます。
mise trust
mise install最後にパッケージのインストールと初期設定を行います。CLIが起動するので、表示に従ってください。
pnpm install
pnpm run setupそれぞれ別のターミナルを開いて実行してください。
pnpm dev:frontend
http://localhost:5173 をブラウザで開いて使用できます。
pnpm dev:backendkcmsxのルートで実行でき、バックエンド、フロントエンド、モックのコードがフォーマットされます。
pnpm formatkcmsxのルートで実行でき、バックエンド・フロントエンドのコードをESLintを用いて構文チェックを行います。
pnpm lintkcmsxは、モノレポを採用しており、packagesフォルダの中に、以下のパッケージが含まれています。
- config kcmsx各種パッケージのための共通の設定ファイルを記述するパッケージ
- kcms バックエンド
- kcmsf フロントエンド
- mock バックエンドが完成するまで暫定で使われていたmock
バックエンドが提供するAPIの定義。
プルリクエスト、コミット、Issueの名前は以下のようにしてください。 ただ、そこまで厳密に考えなくても大丈夫です。
<type>: <title> (例: feat: Q＆Aページの作成)
- type:
fix: バグ修正、内容の更新、依存関係の更新 などfeat: 新しいページの作成、新しい機能の追加 などchore: 軽微な修正(タイプミス修正など)refactor: リファクタリング(プログラム内部の改善)docs: ドキュメント関連の作業 など
- title:
- 短い言葉で、内容を書いてください。
ブランチの名前は以下のようにしてください。
<type>/<issue-number>-<title> (例: feat/10-q-and-a)
- type:
- 上と同じです。
- issue-number:
- Issue番号を書いてください。
- 複数のIssueにまたがっている場合は、どちらか片方の番号を書いてください。
- title:
- 基本的には上と同じです。
- 適切な位置でハイフンを入れることをおすすめします。
プルリクエストを作成する際は、作業した内容をわかりやすくタイトルとコメントを用いて説明してください。
また、最初のコメントには、Close #<issue-number>という内容を記載してください。これを書くことで、プルリクエストとissueを関連づけることができ、このプルリクエストが完了したときに、関連付けられたissueが自動的にCloseされます。
例: #191
プルリクエストを作成したあと、自動テストが実行されます。自動テストが成功するか確認をしてください。
↓実際に失敗してる例
テストが落ちたらDetailsからログが確認できるので、原因を調べて修正してください。
Cloudflareのビルドが落ちた場合、現状ログに関してはPoporon Networkのメンバーしか確認できないようになっています。 ビルドログの確認をしたい場合は、いずれかのメンバーにコンタクトをとって相談してください。
また、コンフリクトが発生した場合、以下の表示がされています。こちらについても修正してください。
具体的な修正方法は、Use the command lineを開いたときにわかりやすい説明が表示されるので、そちらを参考にしてみてください。
実際に開発するときに、必要になるであろう事柄について、いくつか記述します。ここは必要に応じて読んでください。
REST APIを叩いたことがない人向けの資料 httpie.md