twinte-timetable-service
時間割アプリ Twin:te - https://app.twinte.net のv3バックエンドの一部です。
ユーザーが履修している講義の情報を管理します。
利用方法
ビルド済みDockerImageが利用できます。
環境変数名 | 説明 | default |
---|---|---|
PG_HOST | Postgres接続先のホスト名 | postgres |
PG_PORT | Postgres接続先のポート番号 | 5432 |
PG_DATABASE | Postgres接続先のデータベース名 | twinte_timetable_service |
PG_USER | Postgres接続に使用するユーザー名 | postgres |
PG_PASSWORD | Postgres接続に使用するパスワード | postgres |
LOG_LEVEL | ログレベル fatal / error / warn / info / debug / trace / off | info |
開発方法
Docker + VSCodeを推奨します。 以下その方法を紹介します。
- RemoteDevelopment拡張機能をインストール
- このプロジェクトのフォルダを開く
- 右下に
Folder contains a Dev Container configuration file. Reopen folder to develop in a container
と案内が表示されるのでReopen in Container
を選択する。(表示されない場合はコマンドパレットを開きopen folder in container
と入力する) - node14の開発用コンテナが立ち上がりVSCodeで開かれます。また、別途postgresも立ち上がり利用できるようになります。
yarn install
で依存をインストールします。yarn proto
でgrpcに必要なファイルを生成します(開発中にprotoを変更した際も実行してください)yarn dev
で立ち上がります。
また、yarn test
でテストを実行、yarn build
でビルドできます。
yarn client
を実行するとcliでgrpcリクエストを送れるgrpccが利用できます。
v3バックエンドサービス一覧
- API Gateway
- Auth Callback
- User Service
- Session Service
- Timetable Service (here)
- Course Service
- Search Service
- Donation Service
- School Calendar Service
- Information Service
- Task Service