Skip to content

v3バックエンド / kdbから講義情報の取得と管理

Notifications You must be signed in to change notification settings

twin-te/course-service

Repository files navigation

test

twinte-course-service

時間割アプリ Twin:te - https://app.twinte.net のv3バックエンドの一部です。

kdbから講義情報の取得と管理を行います。

利用方法

ビルド済みDockerImageが利用できます。

環境変数名 説明 default
PG_HOST Postgres接続先のホスト名 postgres
PG_PORT Postgres接続先のポート番号 5432
PG_DATABASE Postgres接続先のデータベース名 twinte_course_service
PG_USER Postgres接続に使用するユーザー名 postgres
PG_PASSWORD Postgres接続に使用するパスワード postgres
LOG_LEVEL ログレベル fatal / error / warn / info / debug / trace / off info

開発方法

Docker + VSCodeを推奨します。 以下その方法を紹介します。

  1. RemoteDevelopment拡張機能をインストール
  2. このプロジェクトのフォルダを開く
  3. 右下に Folder contains a Dev Container configuration file. Reopen folder to develop in a container と案内が表示されるのでReopen in Containerを選択する。(表示されない場合はコマンドパレットを開きopen folder in containerと入力する)
  4. node14の開発用コンテナが立ち上がりVSCodeで開かれます。また、別途postgresも立ち上がり利用できるようになります。
  5. yarn install で依存をインストールします。
  6. yarn proto でgrpcに必要なファイルを生成します(開発中にprotoを変更した際も実行してください)
  7. yarn dev で立ち上がります。

また、yarn test でテストを実行、yarn build でビルドできます。

yarn clientを実行するとcliでgrpcリクエストを送れるgrpccが利用できます。

v3バックエンドサービス一覧

  • API Gateway
  • Auth Callback
  • User Service
  • Session Service
  • Timetable Service
  • Course Service (here)
  • Search Service
  • Donation Service
  • School Calendar Service
  • Information Service
  • Task Service