Skip to content

README.md

Latest commit

 

History

History
62 lines (44 loc) · 2.39 KB

README.md

File metadata and controls

62 lines (44 loc) · 2.39 KB
Raw

ProteinDF Project Portal (ProteinDF.github.io)

This repository contains the source code for the official ProteinDF portal website, built with Material for MkDocs and full bilingual support (English / Japanese).

🚀 Quick Start / ローカル確認手順

1. 前提条件 (Prerequisites)

  • Python 3.9+
  • Git

2. 環境構築 & プレビューサーバー起動

# 仮想環境の作成と有効化 (Create & activate virtual environment)
python3 -m venv .venv
source .venv/bin/activate

# 依存パッケージのインストール (Install dependencies)
pip install -r requirements.txt

# ローカルプレビューサーバーの起動 (Start local server)
mkdocs serve

ブラウザで http://127.0.0.1:8000/ を開くとローカルプレビューを確認できます。
（※ファイルの編集を保存すると、ブラウザが自動リロードされます）

📁 ディレクトリ構成 (Directory Structure)

.
├── .github/workflows/deploy.yml   # GitHub Actions 自動デプロイワークフロー
├── docs/                          # コンテンツソースディレクトリ
│   ├── assets/                    # ロゴ・CSS等のアセット
│   ├── index.en.md / index.ja.md  # トップページ (EN/JA)
│   ├── ecosystem.*.md             # ツール一覧 (EN/JA)
│   ├── publications.*.md          # 論文・引用 (EN/JA)
│   └── community.*.md             # コミュニティ・連絡先 (EN/JA)
├── mkdocs.yml                     # MkDocs設定 (テーマ、i18n等)
├── requirements.txt               # Python依存パッケージ
├── SPECIFICATION.md               # サイト詳細仕様書
├── PROCEDURES.md                  # 開発・運用手順書
└── TODO.md                        # 実装・移行TODOリスト

📖 ドキュメント (Documentation)

  • SPECIFICATION.md: サイト仕様書（技術スタック、デザイン、多言語設計、掲載データ定義）
  • PROCEDURES.md: 開発・運用手順書（編集ルール、数式・BibTeX記法、デプロイ方法）
  • TODO.md: 実装・移行TODOチェックリスト

📜 ライセンス (License)

GNU General Public License v3.0 (GPLv3)