Skip to content

near-everything/every-rss-feed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

every-rss-feed

This is a client app for reading curated RSS feeds.

Just FYI, there is an authenticated section and better-auth connection -- it's not gonna work if you don't run the docker and configure some .env vars, but you shouldn't need any of it rn, it'll just be convenient when we do later.

Remember, this app follows RSS standards strictly, with types in apps/server/src/schemas/feed.ts as the source of truth.

Read LLM.txt in the root for more context about the architecture, RSS philosophy, and technical details.

Setup

  1. docker compose up -d to get PostgreSQL running
  2. bun db:migrate to set up the database schema
  3. bun dev to start both web and server

Architecture

  • Server: Hono.js with tRPC for type-safe APIs, Better-Auth for authentication with NEAR Protocol accounts, Drizzle ORM on PostgreSQL
  • Web: React with TanStack Router for routing, TanStack Query for data fetching, tRPC client for server communication
  • Database: PostgreSQL with Docker Compose setup

Available Scripts

  • bun dev - Start both web and server in development
  • bun dev:web - Start only the web application
  • bun dev:server - Start only the server
  • bun build - Build all applications
  • bun db:push - Apply database schema changes
  • bun db:studio - Open Drizzle Studio database UI
  • bun db:migrate - Run database migrations

Key Files

  • apps/server/src/schemas/feed.ts - The RSS schema definitions that everything else builds on
  • apps/server/src/routers/index.ts - tRPC endpoints for feeds, feed items, and health checks
  • apps/server/src/index.ts - Server setup with Hono, tRPC, and auth middleware
  • LLM.txt - Detailed architecture and RSS philosophy documentation

About

a well-typed client app for reading RSS feeds

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published