Skip to content

CLAUDE.md

Latest commit

 

History

History
69 lines (49 loc) · 2.83 KB

CLAUDE.md

File metadata and controls

69 lines (49 loc) · 2.83 KB

RSS Reader

A personal RSS reader built for Android. Client-only — no backend, no sync, no accounts. The intended audience is one person (the developer).

Design Document

A design document is maintained at DESIGN.md. Consult it for an overview of how the app works before making changes, and update it to reflect any changes you make to the architecture, components, data model, or key flows.

Stack

  • React Native + Expo (~55) with Expo Router (file-based routing)
  • TypeScript (strict mode), path alias @/ → src/
  • pnpm v10 as package manager
  • All state persisted locally via AsyncStorage — no database

Key directories

reader/
  src/app/          # Expo Router pages
  src/components/   # UI components
  src/context/      # FeedsContext — single source of truth for feeds + articles
  src/hooks/        # Theme, color scheme
  src/constants/    # Color palette

Running the app

npx expo run:android

APK builds happen automatically via GitHub Actions on push to main. Requires EXPO_TOKEN repo secret. The APK is published as a GitHub release artifact.

Storage schema

Six AsyncStorage keys — no migrations exist, so changing key names drops all data:

Key Contents
rss_feeds_v2 Array of Feed objects
rss_articles_v2 Array of Article objects
rss_read_ids_v2 Array of article ID strings
rss_progress_v2 Record<id, number> — live scroll progress
rss_reader_progress_v2 Record<id, number> — reader scroll progress
rss_dismissed_urls_v3 Record<url, {feedId, ts}> — dismissed/expired URL cache
rss_article_modes_v1 Record<id, boolean> — per-article mode override (true = live/web, false = reader)

Read state and progress are stored separately from articles to allow fast updates without rewriting the full article list. These are merged onto Article objects at render time.

Non-obvious decisions

  • No backend. Feed fetching happens on-device. Don't introduce a server unless there's a strong reason.
  • Single context for all state. FeedsContext handles feeds, articles, and read state. The app's data needs are simple enough that a query library would add overhead.
  • Background refresh on launch. The app loads from storage immediately, then silently refreshes all feeds. Don't break this pattern — instant display of cached content is intentional.
  • Articles are capped at 50 per feed to keep memory reasonable.
  • Portrait-only. Don't add landscape support.

Known gaps (don't fix unless asked)

  • No tests exist
  • The README is the default Expo template — it's not project docs
  • Article list has no pagination; this is acceptable at current scale

Pushing Changes

  • Before pushing changes:
    • increase the app version
    • run pnpm install to update the lock file