@shizuoka-its/core

静岡大学ITソルーション室（ITS）で使用する共通のデータベースアクセス層とビジネスロジックを提供するTypeScriptライブラリです。

インストール

npm install @shizuoka-its/core

利用例

メンバー情報表示

import { createMemberUseCases, type Member } from "@shizuoka-its/core";  
  
const memberUseCases = createMemberUseCases();  
  
// メンバー情報の取得  
const result = await memberUseCases.getMemberByEmail  
  .execute({ email: "[email protected]" });

console.log(result.member);

アーキテクチャ

このプロジェクトはクリーンアーキテクチャパターンに基づいて設計されています：

src/  
├── domain/           # ドメインエンティティとビジネスルール  
├── application/      # ユースケース層  
├── infrastructure/   # インフラストラクチャ層（リポジトリ実装等）  
├── executable/       # 実行可能な機能のエントリーポイント  
└── index.ts         # ライブラリのメインエントリーポイント  

主な機能

メンバー管理

• メンバーの作成、更新、削除
• メールアドレスによる検索
• 学籍番号による検索
• Discordアカウントとの紐付け

Discordアカウント管理

• Discordアカウントの紐付け
• メンバーごとのDiscordアカウント取得

イベント管理

• イベントの作成、更新、削除
• イベント参加者の管理
• 今後のイベント一覧取得

展示管理

• 展示の作成、更新、削除
• イベントごとの展示一覧
• 展示参加者の管理

ライトニングトーク管理

• ライトニングトークの作成、更新、削除
• イベントごとのライトニングトーク一覧

開発者向けセットアップ

1. リポジトリのクローン

git clone https://github.com/su-its/core.git  
cd core

2. 依存関係のインストール

npm install

3. 環境変数の設定

# .env ファイルを作成  
DATABASE_URL="postgresql://user:password@localhost:5432/su_its_db?schema=public"

4. データベースのセットアップ

# Prismaクライアントの生成  
npx prisma generate  
  
# マイグレーションの実行（開発環境）  
npx prisma migrate dev

ビルドとパブリッシュ

# ビルド
npm run build

バージョン管理

# アルファ版の作成  
npm run version:alpha

# ベータ版のパブリッシュ  
npm run publish:beta

# リリース候補版の作成  
npm run version:rc

# パッチバージョンの更新  
npm run version:patch  
  
# マイナーバージョンの更新  
npm run version:minor  

# メジャーバージョンの更新  
npm run version:major  

データベースマイグレーション

詳細なマイグレーション手順については、マイグレーションガイドを参照してください。

基本的なマイグレーションコマンド

# 開発環境でのマイグレーション  
npx prisma migrate dev --name your_migration_name  
  
# 本番環境でのマイグレーション適用  
npx prisma migrate deploy  
  
# マイグレーション状態の確認  
npx prisma migrate status  
  
# データベースの可視化  
npx prisma studio

コントリビューター

• @KinjiKawaguchi
• @KikyoNanakusa