metadata

title: CodeLumia
emoji: 📚
colorFrom: purple
colorTo: blue
sdk: docker
app_port: 8501
app_file: app.py
pinned: false
license: mit

CodeLumia

～Learn to Code, Step by Step～

🚀 はじめに

CodeLumiaへようこそ！CodeLumiaは、GitHubリポジトリのソースコードを分析し、包括的なマークダウン形式のドキュメントを自動生成するツールです。プロジェクトの構造、依存関係、設定などを簡単に理解できるようになります。

CodeLumiaは、開発者がコードベースをすばやく把握し、プロジェクトに効率的に貢献できるようにすることを目的としています。新しいチームメンバーのオンボーディングを容易にし、コードの保守性を向上させます。

このリポジトリはSourceSageを活用しており、リリースノートやREADME、コミットメッセージの9割はSourceSage ＋ claude.aiで生成しています。

主な特徴:

GitHubリポジトリの自動分析
マークダウン形式のドキュメント生成
ファイルとディレクトリの無視パターンのカスタマイズ
わかりやすいStreamlitユーザーインターフェース

CodeLumiaを使用して、プロジェクトのドキュメンテーションを強化し、チームのコラボレーションを促進しましょう。ぜひお試しください！

デモアプリ

前提条件

Docker
Docker Compose

インストール

リポジトリをクローンします:

git clone https://github.com/Sunwood-ai-labs/CodeLumia.git
cd CodeLumia

Dockerコンテナをビルドして実行します:
```
docker-compose up --build
```
ブラウザで http://localhost:8501 にアクセスしてアプリケーションを開きます。

📖 使い方

分析したいGitHubリポジトリのURLをテキスト入力フィールドに入力します。
アプリケーションがリポジトリをクローンし、ファイルを処理して、マークダウンのドキュメントファイルを生成します。
生成されたドキュメントがStreamlitアプリに表示されます。
"Download Markdown File"リンクをクリックして、マークダウンファイルをダウンロードできます。

Full Textのところからクリップボードにコピーすることもできます

🔧 設定

.CodeLumiaignoreファイルには、ドキュメント生成プロセス中に無視する特定のファイルとディレクトリのパターンが含まれています。これらのパターンは、Streamlitアプリのサイドバーで編集できます。

📂 プロジェクト構造

CodeLumia/
├─ .github/
│  └─ workflows/
│     └─ run.yaml
├─ docs/
│  ├─ language_map.json
│  ├─ page_front.md
│  └─ SourceSageDocs.md
├─ modules/
│  ├─ file_operations.py
│  ├─ git_operations.py
│  └─ markdown_operations.py
├─ app.py
├─ CodeLumia.md
├─ docker-compose.yml
├─ Dockerfile
├─ README.md
└─ requirements.txt

🤝 コントリビューション

コントリビューションは大歓迎です！問題を見つけたり、改善のための提案がある場合は、issueを開くかプルリクエストを送ってください。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。 ```