Skip to content

boborder/getting

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌕 みんな〜やってるか! - Web3 コミュニティプラットフォーム

ライブデモ リポジトリ ハッカソン Cloudflare

🌐 今すぐ体験: https://やってるか.みんな


📖 目次


🚀 クイックスタート

前提条件

  • Node.js: ≥20.0.0
  • Bun: ≥1.2.19 (推奨)
  • Git: 最新版

30 秒セットアップ

git clone https://github.com/boborder/getting.git
cd getting
bun i && cp .env.example .dev.vars
bun run db:setup && bun run dev

http://localhost:3000 でアクセス

主要コマンド

bun run dev        # 開発サーバー
bun run test       # テスト実行
bun run build      # ビルド
bun run deploy     # デプロイ
bun run lint       # コード品質チェック

💡 プロジェクト概要

みんな〜やってるか! は、Web3・AI・暗号通貨技術を統合したコミュニティ主導型プラットフォームです。

🎯 ビジョン

暗号通貨投資の民主化を目指し、専門用語で難しい暗号通貨の世界を「みんな」で支え合い、情報を共有し、一緒に成長できる場を提供します。

📊 解決する課題と解決策

😰 現在の問題 🎯 私たちの解決策
情報格差
初心者には難しすぎる
コミュニティ投稿
みんなで情報共有
孤独な投資判断
誰に相談すればいいの?
リアルタイム相談
一人じゃない投資
ツールが複雑
ウォレット管理が大変
XUMM 簡単認証
秘密鍵の管理不要
価格変動の見逃し
重要な機会を逃す
価格アラート
重要な変動を通知

✨ 主要機能

  • 🎨 モダン UI: React Router v7 + DaisyUI によるレスポンシブ設計
  • 高速 API: Hono + Cloudflare Workers による低レイテンシ
  • 🗄️ スケーラブル DB: Drizzle ORM + D1 による自動スケーリング
  • ⛓️ ブロックチェーン: XRPL + XUMM による安全な認証・取引
  • 🤖 AI 統合: MCP + Workers AI による自動化
  • 🔒 セキュリティ: JWT + WebCrypto による高度なセキュリティ

🏗️ アーキテクチャ設計

11 層のレイヤードアーキテクチャを採用し、責任分離と高い保守性を実現:

graph TB
    subgraph "📚 Document Layer (0)"
        DOC[ドキュメント・設計・分類管理]
    end
    subgraph "🎨 Frontend Layer (1)"
        FE[React Router v7 + Jotai + DaisyUI]
    end
    subgraph "⚡ Backend Layer (2)"
        BE[Hono + OpenAPI + Valibot]
    end
    subgraph "🗄️ Database Layer (3)"
        DB[Drizzle ORM + Cloudflare D1]
    end
    subgraph "🔒 Schema Layer (4)"
        SC[Valibot + JSON Schema]
    end
    subgraph "🧪 Testing Layer (5)"
        TS[Vitest + Bun Test + Playwright]
    end
    subgraph "🔐 Security Layer (6)"
        SE[JWT + XUMM + WebCrypto]
    end
    subgraph "🛠️ Development Layer (7)"
        DEV[TDD + CI/CD + Best Practices]
    end
    subgraph "☁️ Cloudflare Layer (8)"
        CF[Workers + Durable Objects + KV]
    end
    subgraph "🤖 AI Layer (9)"
        AI[MCP + Workers AI + Agents]
    end
    subgraph "⛓️ Crypto Layer (10)"
        CR[XRPL + IPFS + WebCrypto]
    end

    DOC -.-> FE & BE & DB & SC & TS & SE & DEV & CF & AI & CR
    FE --> BE --> DB
    BE --> SC & CF & AI
    DB --> CF
    SC --> BE & DB
    AI --> CF
    CR --> BE
Loading

🎯 設計原則

  1. 層責任分離: 各層は明確な責任範囲を持つ
  2. 依存関係管理: 上位層 → 下位層のみ、循環依存禁止
  3. 型安全性: TypeScript strict mode による完全な型保証
  4. テスト駆動: TDD による品質保証
  5. Web Standards: ランタイム非依存の標準 API 使用

🛠️ 技術スタック

🎨 フロントエンド

技術 バージョン 用途
React ^19.1.0 UI 構築
React Router ^7.7.0 ルーティング・SSR
Jotai ^2.12.5 状態管理
SWR ^2.3.4 データフェッチング
DaisyUI ^5.0.46 UI コンポーネント
Tailwind CSS ^4.1.11 スタイリング

⚡ バックエンド

技術 バージョン 用途
Hono ^4.8.5 Web フレームワーク
OpenAPI ^0.4.8 API 仕様・ドキュメント
Valibot ^1.1.0 スキーマバリデーション
Drizzle ORM ^0.44.3 データベース ORM

🧪 テスト・品質

技術 バージョン 用途
Vitest ^3.2.4 ユニット・統合テスト
Playwright ^1.54.1 E2E テスト
Biome ^2.1.2 コード品質・フォーマット
TypeScript ^5.8.3 静的型チェック

⛓️ Web3・暗号

技術 バージョン 用途
XRPL ^4.3.0 ブロックチェーン統合
XUMM ^1.8.0 ウォレット認証
IPFS ^5.2.0 分散ストレージ
Noble Hashes ^1.8.0 暗号化・ハッシュ

詳細な技術仕様は docs/technologystack.md を参照


📦 ディレクトリ構成

レイヤードアーキテクチャに基づく明確な構造

getting/
├── 📚 docs/                    # Document Layer: 設計ルール・仕様
├── 🎨 app/                     # Frontend Layer: React Router v7 アプリ
│   ├── components/             # UIコンポーネント (ui/, layout/, features/)
│   ├── routes/                 # ファイルベースルーティング
│   ├── utils/                  # ユーティリティ関数
│   └── atoms/                  # Jotai 状態管理
├── ⚡ server/                  # Backend Layer: Hono APIサーバー
│   ├── routes/                 # APIルート定義
│   ├── handlers/               # リクエストハンドラー
│   ├── middleware.ts           # ミドルウェア
│   └── schema/                 # サーバーサイドスキーマ
├── 🗄️ drizzle/                # Database Layer: ORM・スキーマ・マイグレーション
├── 🔒 schema/                  # Schema Layer: Valibot バリデーション
├── 🧪 tests/                   # Testing Layer: 全種類のテスト
│   ├── unit/                   # ユニットテスト (Bun)
│   ├── integration/            # 統合テスト (Bun)
│   ├── components/             # コンポーネントテスト (Vitest)
│   ├── e2e/                    # E2Eテスト (Playwright)
│   └── setup/                  # テスト環境設定
├── ☁️ workers/                 # Cloudflare Layer: Workers・Cron
├── 🤖 MCP・AI関連               # AI Layer: 各層に統合
└── ⛓️ 暗号・ブロックチェーン    # Crypto Layer: 各層に統合

詳細は docs/directorystructure.md を参照


🧪 テスト・品質保証

テスト戦略

TDD (テスト駆動開発) を採用し、4 種類のテストで包括的な品質保証:

テストタイプ ツール 現在カバレッジ 目標 用途
ユニットテスト Bun 25% 80% 個別関数・クラス
統合テスト Bun 30% 70% API・DB 統合
コンポーネントテスト Vitest 20% 60% UI コンポーネント
E2E テスト Playwright 15% 40% ユーザーフロー

品質基準

  • 型安全性: TypeScript strict mode
  • コード品質: Biome による自動チェック
  • セキュリティ: 定期的なセキュリティ監査
  • パフォーマンス: Lighthouse スコア 90+

テスト実行

bun run test           # 全テスト実行
bun run test:unit      # ユニットテスト
bun run test:e2e       # E2Eテスト
bun run test:coverage  # カバレッジ付き実行

詳細は docs/testing.md を参照


📚 詳細ドキュメント

📋 設計ルール・仕様書一覧

各層の詳細設計・ベストプラクティス・技術仕様:

ドキュメント 説明
📚 Document document.md ドキュメント管理・分類
🎨 Frontend frontend.md UI・UX・コンポーネント設計
⚡ Backend backend.md API・ビジネスロジック
🗄️ Database database.md データ設計・ORM
🔒 Schema schema.md バリデーション・型定義
🧪 Testing testing.md テスト戦略・TDD
🔐 Security security.md セキュリティ・認証
🛠️ Development development.md 開発プロセス・運用
☁️ Cloudflare cloudflare.md インフラ・エッジ
🤖 AI ai.md AI・自動化
⛓️ Crypto crypto.md ブロックチェーン・暗号

🗺️ プロジェクト管理


🔧 開発環境セットアップ

環境準備

# 1. リポジトリクローン
git clone https://github.com/boborder/getting.git
cd getting

# 2. 依存関係インストール
bun install

# 3. 環境変数設定
cp .env.example .dev.vars
# .dev.vars を編集して必要な値を設定

# 4. データベースセットアップ
bun run db:setup    # ローカルDB作成
bun run db:migrate  # マイグレーション実行

# 5. 開発サーバー起動
bun run dev         # http://localhost:3000

開発フロー

  1. 🔴 Red: テストを書く(TDD)
  2. 🟢 Green: 実装してテストを通す
  3. 🔵 Refactor: コードを改善
  4. 📝 Document: ドキュメント更新
  5. 🚀 Deploy: CI/CD で自動デプロイ

便利なコマンド

# 品質チェック
bun run typecheck   # 型チェック
bun run lint        # リント
bun run format      # フォーマット

# データベース操作
bun run db:studio   # Drizzle Studio 起動
bun run db:seed     # テストデータ投入

# デプロイ
bun run build       # ビルド
bun run deploy      # Cloudflare Workers デプロイ

🤝 コントリビューション

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Run tests (bun run test)
  4. Commit your changes (git commit -m 'Add amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

📄 ライセンス

このプロジェクトは MIT License の下で公開されています。


🚀 みんな〜やってるか! - Web3 コミュニティプラットフォーム Made with ❤️ by the みんな〜やってるか! Team

Star this repo

About

XRPL Apps

Resources

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages