推しアイデア
点数に応じて変化がおきるよ
作った背景
テーマが「みどり」で逆からりーどーみーと読めるのでREADMEに関することをやりたい
推し技術
gemini,gcp,go 触ったことなかったから
プロジェクト詳細
Greend me
概要
このプロジェクトは、より分かりやすく読みやすいREADMEを作成するため、READMEの構成について5つの項目から採点し、評価と改善案を提示するものです
- 使用技術
- 詳細
- Demo
- result画面の変化
- 参考
リポジトリ
使用技術
- React
- three.js
- chart.js
- Vite
- Gemini(gemini-1.5-flash)
- Go
- go-github
- generative-ai-go
- GCP
- Docker
詳細
アーキテクチャ図
機能詳細
このアプリは、urlからリポジトリのREADMEテキストを解析し、以下の5つの基準に基づいて評価を行います。各基準につき0〜10点で採点し、合計評価と改善点を提示します。
プロンプトでの項目
- 明確さ: プロジェクトの目的を明確に説明されているか（0〜10点）
- 完全性: 環境構築、インストール手順、使用方法などの必要な情報がすべて含まれているか（0〜10点）
- 構造化: 情報が論理的に整理されているか（0〜10点）
- 例示: 使用例やコード例が含まれているか（0〜10点）
- 可読性: 文章が読みやすいか（0〜10点）
アプリの機能
- 自動評価: 入力されたREADMEテキストを5つの項目で評価します。各項目は10点満点で採点され、総合的なスコアが表示されます。
- 改善点提案: 各項目の評価結果に基づいて、具体的な改善点を提案します。例として、不明瞭な記述箇所の修正案や、追加すべき情報などを提示します。
- 星観察: 評価点によって星の見た目が変わり、カメラの移動により地上からの景色を観察できます
- 星爆発: READMEをリポジトリから読み込めなかった場合は爆発します
Demo
result画面の変化
担当技術
kuroko(フロントエンド)
- React
- three.js
- chart.js
- Vite
yanai(バックエンド)
- Gemini
- Go
- go-github
- generative-ai-go
- GCP
