README.md

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


<p align="center">
<img src="https://huggingface.co/datasets/MakiAi/IconAssets/resolve/main/CodeLumia_icon.png" width="50%">
<br>
<h1 align="center">CodeLumia</h1>
<h3 align="center">
  ～Learn to Code, Step by Step～

[![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/MakiAi/CodeLumia)[![](https://img.shields.io/github/stars/Sunwood-ai-labs/CodeLumia)](https://github.com/Sunwood-ai-labs/CodeLumia)[![](https://img.shields.io/github/last-commit/Sunwood-ai-labs/CodeLumia)](https://github.com/Sunwood-ai-labs/CodeLumia)[![](https://img.shields.io/github/languages/top/Sunwood-ai-labs/CodeLumia)](https://github.com/Sunwood-ai-labs/CodeLumia)[![GitHub Release](https://img.shields.io/github/v/release/Sunwood-ai-labs/CodeLumia?sort=date&color=red)
](https://github.com/Sunwood-ai-labs/CodeLumia)


</h3>

</p>


## 🚀 はじめに


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

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

>[!TIP]
>このリポジトリは[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage)を活用しており、リリースノートやREADME、コミットメッセージの9割は[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage) ＋ [claude.ai](https://claude.ai/)で生成しています。

### 主な特徴:

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

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


## デモアプリ

[![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/OFA-Sys/OFA-Image_Caption)


![](https://github.com/Sunwood-ai-labs/CodeLumia/blob/develop/docs/demo.gif?raw=true)

## 更新履歴

### [[2024/04/15] CodeLumia v0.4.0](https://github.com/Sunwood-ai-labs/CodeLumia/releases/tag/v0.4.0)
- プレビュー機能の追加（ファイルツリー、マークダウン、プレーンテキスト）
- リポジトリのスキャンとマークダウンファイルの生成機能を強化
- ドキュメンテーションの改善とコードの可読性向上
- ファイル操作とGit操作のモジュールを改善

### [[2024/04/13] CodeLumia v0.3.0](https://github.com/Sunwood-ai-labs/CodeLumia/releases/tag/v0.3.0) 
- アプリケーションの機能強化とドキュメントデザインの更新
- デモGIFの更新 
- `.CodeLumiaignore`のフォーマット更新とリファクタリング
- READMEとSourceSageDocsの大幅な更新
- GIFファイルのGit LFSでの追跡と誤記修正

### [[2024/04/13] CodeLumia v0.2.0](https://github.com/Sunwood-ai-labs/CodeLumia/releases/tag/v0.2.0) 
- コードのリファクタリングによる可読性と保守性の向上
- リポジトリのURLを入力してファイルツリーとコードを表示する機能追加
- ユーザーインターフェースの改善とドキュメンテーションの拡充
- CI/CDの設定とREADMEファイルの更新
- 

### [2024/04/12] CodeLumia v0.1.0
- 初回リリース

### 前提条件

- Docker
- Docker Compose

### インストール

1. リポジトリをクローンします:
   ```bash
   git clone https://github.com/Sunwood-ai-labs/CodeLumia.git
   cd CodeLumia
   ```

2. Dockerコンテナをビルドして実行します:
   ```bash
   docker-compose up --build
   ```

3. ブラウザで `http://localhost:8501` にアクセスしてアプリケーションを開きます。

## 📖 使い方

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

>[!TIP]
>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ライセンス](LICENSE)の下で公開されています。
```