Skip to content

ryu/tsubame

Repository files navigation

Tsubame

Fastladder 互換のパーソナルフィードリーダー。複数ユーザー対応のセルフホスト型アプリケーション。

主な機能

  • 3 ペイン UI(フィード一覧 / エントリ一覧 / エントリ本文)
  • Fastladder 互換キーボードショートカット(j/k/s/a/v/p/o/r/Shift+A)
  • OPML インポート・エクスポート
  • 定期フィードクロール(RSS 2.0 / Atom / RDF 対応)
  • エントリの既読管理・ピン留め
  • モバイル対応・ダークモード対応
  • パスワードレス認証(マジックリンク)

動作要件

  • Ruby 4.0+
  • SQLite3

セットアップ

git clone https://github.com/ryu/tsubame.git
cd tsubame
bin/setup

初回ユーザーを作成:

TSUBAME_EMAIL=you@example.com bin/rails db:seed

開発サーバーを起動:

bin/dev

http://localhost:3000 にアクセスし、メールアドレスを入力するとログインリンクが届きます。

メール送信の設定(本番環境)

Resend を使用します。API キーを取得後、credentials に設定してください:

VISUAL="nvim" bin/rails credentials:edit
resend:
  api_key: re_xxxxxxxxxx

開発コマンド

bin/dev          # 開発サーバー起動
bin/ci           # CI (rubocop, security audit, テスト)
bin/rails test   # テストのみ
bin/rubocop      # Lint のみ

デプロイ

Kamal 2 を使った Docker デプロイに対応。詳細は docs/deployment.md を参照。

kamal deploy

技術スタック

  • Ruby 4.0.5 / Rails 8.1 / SQLite3
  • Hotwire (Turbo + Stimulus) + Vanilla CSS
  • Solid Queue (バックグラウンドジョブ)
  • Kamal 2 (デプロイ)

ドキュメント

ライセンス

MIT License

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors