Skip to content

ドキュメントとデモデータの整備 #39

@yellow-seed

Description

@yellow-seed

概要

サンプルアプリケーションのドキュメントとすぐに試せるデモデータを整備します。

タスク

sample_app/README.md

  • セットアップ方法の詳細
    • 必要な環境(Ruby, Node.js, PostgreSQL等)
    • 環境変数の設定方法
    • データベースのセットアップ
  • ローカル環境での起動方法
  • Docker環境での起動方法
  • 各機能の使い方
  • トラブルシューティング

デモデータ

  • テストネットのトランザクションハッシュ例
    • Sepolia
    • Goerli(廃止予定だが参考に)
    • その他利用可能なテストネット
  • 変換機能で試せるサンプル値
  • READMEまたはseedデータとして提供

ルートREADME.mdの更新

  • サンプルアプリケーションへのリンク追加
  • サンプルアプリの簡単な説明
  • クイックスタートガイドへのリンク

期待される成果物

  • 誰でも簡単にセットアップして試せるドキュメント
  • すぐに動作確認できるデモデータ

デモデータ例

Sepolia Testnet:
- Transaction Hash: 0x... (成功したトランザクション)
- Transaction Hash: 0x... (失敗したトランザクション)

関連

全機能の実装完了後に最終的なドキュメント整備

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions