NBDC ヒトデータベース (https://humandbs.dbcls.jp) のポータルである。研究とそれに属するデータセットの内容を admin が編集して公開し、公開ページ・検索・JSON API・データファイルの配信を提供する。
手元で動かす手順は docs/development.md にある。本番と staging の構成と手順は docs/deployment.md にある。公開データを機械で取得するときは docs/public-api.md から読む。
上から順に読めば、どこに何があり、何をしてはいけないかが分かるように並べている。
| ファイル | 内容 |
|---|---|
| docs/overview.md | 全体像。構成要素、データの流れ、ディレクトリ |
| docs/concepts.md | 用語。研究・バージョン・下書き・データセット・ID などの意味と関係 |
| ファイル | 内容 |
|---|---|
| docs/data-model.md | DB の構造と制約。研究の内容の保存形式、実体と ID、値の状態、検索用の行、日付 |
| docs/catalog.md | 項目定義と語彙。キーの型と名前、画面から編集できる語彙、疾患 (ICD10) |
| docs/upstream.md | 外部から取ってきたデータ。取得元とキャッシュ、失敗したとき、制限公開データの利用者、データセットのファイルの大きさと形式 |
| docs/editing.md | 下書きの編集。同時編集と保存、取り込み、申請から研究を作る、レビュー、場所の呼び方 |
| docs/publishing.md | 公開。バージョン番号、公開前の確認、ID の割り当て、取り下げと削除、操作の記録、Slack への通知 |
| docs/files.md | データファイル。2 つの bucket と研究ごとの prefix、アップロード、公開と非公開の切り替え、データセットとの対応、研究のページへの表示、ラベル |
| docs/site-content.md | 記事・お知らせ・アラート。本文の保存形式、slug とバージョン、表示の条件 |
| docs/auth.md | ログインと権限。誰が何をできるか、セッション、admin の追加と削除 |
| docs/assistant.md | 申請支援アシスタントとポータルの境界 |
| docs/public-site.md | 公開サイト。URL と言語、公開範囲、研究とデータセットのページ、検索式と絞り込み、書き出し、カート、検索エンジンとリンクのプレビュー |
| docs/public-api.md | 外部に互換性を保証している JSON API。応答の形、検索と一括取得、互換性、エラー、DDBJ Search への提供 |
| ファイル | 内容 |
|---|---|
| docs/development.md | 手元で動かす手順。初回、日常のコマンド、DB と schema の変更、開発用データ |
| docs/testing.md | テストの書き方。種類、何をテストにするか、mock の境界、テスト同士の独立 |
| docs/deployment.md | 本番と staging を動かす手順。構成、.env、データの保存先、ログ、初回、更新、戻す、backup、schema を変える |
Apache License 2.0 (LICENSE)。