Skip to content

HeavenOSK/technical-doc-accessible-reader

Repository files navigation

Technical Document Accessible Reader

技術文書の読み上げテキストを生成するデモアプリケーションです。

概要

このプロジェクトは、技術文書をより分かりやすい読み上げテキストに変換するデモンストレーションを提供します。OpenAI APIとAnthropicのClaude APIを活用して、技術的な内容をよりアクセシブルな形式に変換します。

機能

  • 技術文書の読み上げテキスト生成
  • OpenAIとClaude Sonnetモデルの切り替え機能
  • 生成されたテキストの読み上げ機能
  • ドキュメントの保存と履歴管理
  • 選択したモデルの設定保存

技術スタック

セットアップ

  1. リポジトリのクローン:
git clone https://github.com/HeavenOSK/technical-doc-accessible-reader.git
cd technical-doc-accessible-reader
  1. 依存関係のインストール:
npm install
# または
pnpm install
  1. 環境変数の設定:
  • .env.exampleファイルを.envにコピー
  • 必要なAPIキーを設定:
OPENAI_API_KEY=your_openai_api_key_here
ANTHROPIC_API_KEY=your_anthropic_api_key_here  # Claudeモデルを使用する場合に必要

開発サーバーの起動

開発サーバーを起動するには、以下のコマンドを実行します:

npm run dev
# または
pnpm dev

http://localhost:3000をブラウザで開いて、アプリケーションにアクセスできます。

使用方法

  1. 画面上部のボタンでOpenAIまたはClaudeモデルを選択
  2. 左側のパネルに技術文書を入力
  3. 「生成」ボタンをクリックして読み上げテキストを生成
  4. 「読み上げ」ボタンで生成されたテキストを音声で確認
  5. 「保存」ボタンでドキュメントを保存

選択したモデルの設定は自動的に保存され、ブラウザを再起動しても維持されます。

Claudeモデルの使用について

Claudeモデルを使用する場合は、以下の手順が必要です:

  1. Anthropicでアカウントを作成
  2. APIキーを取得
  3. .envファイルにANTHROPIC_API_KEYを設定
  4. アプリケーション上部の「Claude」ボタンをクリックしてモデルを切り替え

Claudeモデルは、特に長文や複雑な技術文書の変換に優れた性能を発揮します。ただし、APIキーの設定がない場合はOpenAIモデルのみが使用可能です。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published