Skip to content
BranchesTags

Repository files navigation

Nugget - 社内ToDo管理アプリケーション

社内全員への有効期限付きToDoを登録・管理できるアプリケーションです。

月末の工数入力対応期限など、全社員に対してやってもらうべきことをToDoリストとして一箇所で管理し、対応漏れを減らして対応率を上げることを目的としています。

機能

  • SAML 2.0認証: Okta, Azure AD, Google WorkspaceなどのIdPと連携
  • ユーザー同期: SCIM 2.0
  • ToDo管理:
    • 管理者による全社・グループ・個人へのToDo作成
    • 期限設定とリマインダー
    • 完了状況のリアルタイム集計
  • 進捗管理:
    • 分析ダッシュボード: システム全体の利用状況と達成率を可視化
    • 進捗管理リスト: 作成したタスクの完了状況（誰が未完了か）を一覧確認
  • 通知連携: Slackへの新規ToDo通知、リマインダー通知

技術スタック

  • Backend: .NET / ASP.NET Core Web API
  • Frontend: Blazor WebAssembly
  • Database: TiDB (MySQL互換 NewSQL)
  • Cache: IMemoryCache (インメモリキャッシュ)
  • Container: Docker / Docker Compose

ローカル開発環境 (Docker)

Docker Composeを使用して、ローカル環境ですぐにアプリケーションを起動できます。 開発環境では TiDB がコンテナとして同梱されます。

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

git clone https://github.com/miutaku/nugget.git
cd nugget

2. 環境変数の設定

docker ディレクトリ内の .env.example をコピーして .env を作成し、必要な値を設定します。

cd docker
cp .env.example .env
nano .env # またはお好みのエディタで編集

3. 証明書の配置 (SAML認証用)

SAML IdPから取得した証明書ファイル（.cert または .pem）を docker ディレクトリに配置します。デフォルトのファイル名は idp_cert.cert です。 ※ ファイル名を変える場合は、.env の SAML_IDP_CERTIFICATE_PATH も変更してください。

4. アプリケーションの起動

docker compose up -d

5. アクセス

本番デプロイ

本番環境では GHCR に公開されたイメージと、外部の TiDB（TiDB Serverless 等）を使用します。

1. 環境変数の設定

.env に本番用の値を設定します。特に DATABASE_CONNECTION_STRING に外部 TiDB の接続文字列を指定してください。

cd docker
cp .env.example .env
# 以下の値を本番用に設定:
# DATABASE_CONNECTION_STRING=Server=<tidb-host>;Port=4000;Database=nugget;User=<user>;Password=<password>;SslMode=Required;
# APP_URL=https://your-domain.com
# IMAGE_TAG=v1.0.0

2. デプロイ

docker compose -f docker-compose.prod.yml up -d
構成 用途 TiDB イメージ
docker-compose.yml 開発環境 コンテナ同梱 ローカルビルド
docker-compose.prod.yml 本番 (Docker Compose) 外部 (TiDB Serverless等) GHCR
k8s/ 本番 (Kubernetes) 外部 (TiDB Serverless等) GHCR

Kubernetes デプロイ

k8s/ ディレクトリに Kubernetes マニフェストを用意しています。

1. Secret の設定

k8s/secret.yaml の値を環境に合わせて編集します。

vim k8s/secret.yaml
# DATABASE_CONNECTION_STRING, SCIM_API_TOKEN 等を設定

2. IdP 証明書の登録

kubectl create secret generic nugget-idp-cert \
  --from-file=idp_cert.cert=docker/idp_cert.cert \
  -n nugget

3. マニフェストの適用

kubectl apply -f k8s/

マニフェスト一覧

ファイル 内容
namespace.yaml nugget Namespace
configmap.yaml 非機密設定 (APP_URL等)
secret.yaml 機密設定 (DB接続, トークン等)
api-deployment.yaml API Deployment (2レプリカ) + PVC
web-deployment.yaml Web Deployment (2レプリカ)
services.yaml API / Web の ClusterIP Service
ingress.yaml Ingress (nginx + cert-manager TLS)

設定 (Environment Variables)

docker/.env で設定可能な環境変数の一覧です。

認証 (SAML / SCIM)

変数名 必須 説明 デフォルト値 / 例
SAML_IDP_ENTITY_ID ✅ IdPのEntity ID (Issuer) http://www.okta.com/...
SAML_IDP_SSO_URL ✅ IdPのSSO URL (Login URL) https://your-org.okta.com/.../sso/saml
SAML_IDP_METADATA_URL IdPのメタデータXMLのURL
SAML_IDP_CERTIFICATE_PATH コンテナ内の証明書パス /app/idp_cert.cert
SAML_ADMIN_EMAILS ✅ 管理者権限を付与するメールアドレス (カンマ区切り) admin@example.com,user@example.com
SCIM_API_TOKEN ✅ SCIM API認証用トークン (任意の文字列) (ランダムな文字列を生成してください)
ORG_NAME 組織名（ヘッダーに表示されます） 株式会社Nugget

通知 (Slack)

変数名 必須 説明 デフォルト値 / 例
SLACK_BOT_TOKEN ✅ Slack AppのBot User OAuth Token xoxb-...

データベース接続 (docker-compose.yml内で定義)

デフォルトでは docker-compose.yml 内で TiDB コンテナへの接続が設定されています。変更が必要な場合は docker-compose.yml の ConnectionStrings__DefaultConnection を編集してください。

SCIM プロビジョニング設定 (例: Okta)

例として、Okta からユーザー・グループを自動同期するための設定手順です。

Okta 側の設定

設定項目 値
SCIM バージョン 2.0
SCIMコネクターのベースURL https://<your-domain>/api/scim/v2
ユーザーの一意のIDフィールド userName
認証モード HTTP Header
Authorization Bearer <SCIM_API_TOKENの値>

サポートされているプロビジョニングアクション

アクション 対応
Import New Users ✅
Import Groups ✅
新規ユーザーをプッシュ ✅
プロファイルの更新をプッシュ ✅
プッシュグループ ✅

Enterprise User 属性マッピング

SCIM Enterprise User Schema (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User) に対応しています。以下の属性がユーザーに同期され、ToDo の属性ベースターゲティングに利用できます。

SCIM 属性 Nugget フィールド 用途例
department 部署 「営業部」全員にToDo割り当て
division 事業部 事業部単位での割り当て
title 役職 役職ベースの割り当て
organization 組織 組織単位での割り当て
costCenter コストセンター コストセンター単位での割り当て
employeeNumber 社員番号 個人の識別

ユーザー名の同期仕様

Nugget では、以下のルールに基づいてユーザーの氏名（表示名）を決定・更新します。

1. 自動作成時の挙動 (SAML / SCIM)

  • データベースにユーザーが存在しない状態で認証（SAML）または同期（SCIM）が行われた場合、ユーザーが自動作成されます。
  • SAML ログインによる自動作成時は、氏名は一律で 「不明な氏名」 となります（氏名情報は SCIM からのみ提供される想定のため）。
  • SCIM 同期による自動作成時は、リクエストに含まれる displayName が設定されます（未設定時は「不明な氏名」）。

2. SCIM による情報の更新

  • 既に「不明な氏名」で登録されているユーザー（SAML で初回ログインしたユーザーや、SAML_ADMIN_EMAILSでAdminとして指定したユーザー等） に対しても、SCIM 経由で displayName が送信されたタイミングで、正しい氏名に自動更新されます。

ディレクトリ構成

nugget/
├── src/
│   ├── Nugget.Api/          # Backend API
│   ├── Nugget.Web/          # Frontend (Blazor WASM)
│   ├── Nugget.Core/         # Domain Entities & Interfaces
│   └── Nugget.Infrastructure/ # EF Core & External Services
├── docker/                  # Docker configuration
│   ├── .env                 # Environment variables (git-ignored, copy from .env.example)
│   ├── docker-compose.yml   # 開発環境用
│   ├── docker-compose.prod.yml # 本番環境用 (Docker Compose)
│   ├── Dockerfile           # Multi-stage build definition
│   └── nginx.conf           # Web server configuration
├── k8s/                     # Kubernetes マニフェスト
│   ├── namespace.yaml
│   ├── configmap.yaml
│   ├── secret.yaml
│   ├── api-deployment.yaml
│   ├── web-deployment.yaml
│   ├── services.yaml
│   └── ingress.yaml
└── tests/                   # Unit Tests

ライセンス

MIT License

About

No description, website, or topics provided.

Resources

Readme
MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages