はじめに

ホスト版Webアプリ

最も手軽に始めるなら、ホスト版Webアプリがおすすめです。

  1. app.flashcards-open-source-app.com を開きます
  2. パスワードレスのメール OTP でサインインします
  3. カードを作成し、復習期限が来た項目をこなし、ワークスペースのデータやファイル添付を使って AI チャットを利用します

この方法なら、インストールやサーバー設定は不要です。

エージェントのセットアップ

Claude Code、Codex、OpenClaw を直接接続する場合は、まず次のURLから始めます。

GET https://api.flashcards-open-source-app.com/v1/

このディスカバリーレスポンスには、メール OTP によるログイン、長期利用向け API key の作成、アカウント情報の取得、ワークスペースの初期化、公開されている SQL インターフェースの利用開始までに必要な情報が含まれています。

同じ内容は GET /v1/agent でも取得できますが、正式な公開エントリーポイントは /v1/ です。

セルフホスティング

自分でインスタンスを運用したい場合は、セルフホスティングガイド を参照してください。

現在利用できるもの

  • カード作成、復習、AIチャットを利用できるホスト版Webアプリ
  • ローカル SQLite とオフラインファースト同期を備えた iOS クライアント
  • api ドメインと auth ドメインで分けて提供される共有バックエンドと認証サービス
  • ディスカバリー、OTP、ApiKey 認証による外部エージェント向けの接続フロー
  • Postgres を正本データストアとする、AWS 上でのオープンソース運用構成

リポジトリの方向性

このプロジェクトはオフラインファーストを前提に設計されています。

現在のリポジトリには、Webアプリ、iOS アプリ、認証サービス、バックエンド API、外部エージェント向けフロー、そして Google Play で公開中の Android アプリが含まれています。