デジコア

芝浦工業大学デジクリのグループウェアです

現在の開発中のバージョンはπです

採用技術

技術名	説明	バージョン
Next.js	ReactベースWebアプリフレームワーク	13
Prisma	TSと相性の良いORM	5.2
TypeScript	JSに静的型付けとクラスベースオブジェクト指向を加えた物	5.2.2
TailwindCSS	拡張性の高いOSSなCSSフレームワーク	3.3.3
flowbite	TailwindCSS向けのUIライブラリ	1.8

開発環境セットアップ

1. 以下のソフトウェアを用意する

• docker
• make （Windows環境であればWSL上に構築することを推奨）

2. .envファイルの用意

.env.sampleの内容をコピーして.envファイルを作成する

3. コンテナのビルド

make build

4. DBのマイグレーション

make up-d
make dev-migrate

5. 停止と実行

make down //コンテナの停止
make up //コンテナの起動
make up-d //バックグラウンドでコンテナ起動

開発の仕方

1. ブランチを生やす

ブランチは以下の命名規則を守ってください

• 新機能の開発の場合 => feature/(機能の名前)
• 機能向上の開発の場合 => enhance/(機能の名前)
• バグなどの修正の場合 => fix/(機能の名前)

機能の名前はblog-postのような命名でお願いします。

例）
ブログの投稿機能を作る場合
feature/blog-post

2. DraftPR の作成

少しでも作業が進み、コミットができたら、リモートにプッシュしてドラフトプルリクエストを作成します。

概要の部分には作業した項目やこれから作業することを ToDo 形式で記入します。 ブログ投稿機能作成の例

- [ ] ブログ投稿作成ページの作成
- [ ] ブログ投稿閲覧ページの作成
- [ ] ブログ一覧閲覧ページの作成

書けたらDraft pull requestで作成します。

3. がんばって作る

頑張って作ります。 コミットは作業している内容が分かりやすいようにこまめに行いましょう。

4. PR の整備とレビューの準備

PR で行っている ToDo が完了して master に Merge する準備ができたら、レビューを受けるためにプルリクエストの内容をよりよくしていきます。 再度、概要で定義した ToDo をやっているかはもちろん確認してください。
その他、新しい機能の場合はどんな感じかがわかるスクリーンショットをはったり、修正した場合は前と後でスクショがあるとわかりやすいです。

また、破壊的変更がないかや最後のチェック項目も確認しましょう。

ここまでできたらレビュワーを指定します。 GitHub のReviewersの歯車ボタンをクリックしてレビュ依頼をする人を選択します。

5. Mattermost で報告

GitHub の通知だけでは気づきにくいので、Mattermost の~system-developmentチャンネルにてメンション付きでレビュー依頼を PR の URL 付きで送りましょう。

6. Approve されたら

Approve されたら PR 内の Merge ボタンを押し、Merge を実行します。Merge されたら Delete branch ボタンで対象のブランチを削除しましょう。 これで一連の作業は終わりです。