Skip to content

madpin/Neureed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧠 NeuReed - Your RSS Reader, But Way Smarter

Build & Deploy License Node.js 24 Next.js 16

NeuReed is an RSS reader that actually understands what you read. Using AI and semantic search, it learns your interests and surfaces content you'll actually care about. No more drowning in feeds - just the good stuff.

✨ Why NeuReed?

  • 🤖 AI That Gets You: The more you read, the better it understands your interests
  • 🔍 Search That Actually Works: Find articles by meaning, not just keywords
  • 🎨 Beautiful & Customizable: Dark mode, themes, reading preferences - make it yours
  • 🚀 Blazing Fast: Built on Next.js 16 with pgvector for instant semantic search
  • 💰 Cost-Aware: Track your OpenAI usage or use free local models
  • 🔐 Privacy First: Self-hosted, your data stays yours

🎯 What Makes It Different?

Semantic Search That Blows Your Mind 🧠

Type "machine learning tutorials for beginners" and get relevant articles even if they never used those exact words. That's the power of vector embeddings.

Personal Learning Engine 📚

  • Thumbs up articles you love, thumbs down ones you don't
  • NeuReed learns from your reading patterns automatically
  • Get personalized article scores based on your interests
  • Articles you'll love float to the top

Flexible AI Models 🔧

  • OpenAI GPT models: Powerful summaries and embeddings
  • Local models: Zero cost, complete privacy
  • Bring your own: Use any OpenAI-compatible endpoint
  • Per-feature models: Different models for summaries vs embeddings

Feed Management Done Right 📰

  • Organize feeds into categories that make sense
  • Set refresh intervals per feed, category, or globally
  • OPML import/export for easy migration
  • Automatic cleanup of old articles

🚀 Quick Start

Option 1: Automated Setup (Easiest!)

# Clone and setup
git clone https://github.com/madpin/neureed.git
cd neureed
./scripts/setup.sh

# Start developing
npm run dev

The setup script handles everything: environment files, Docker containers, dependencies, database setup, and even sample data if you want it.

Option 2: Docker Compose (Production-ish)

# Start everything (app + database)
docker-compose up -d

# Check it out
open http://localhost:3000

Option 3: Manual (You Like Pain?)

Click to expand manual setup
# Install dependencies
npm install

# Create environment file
cp .env.example .env.local

# Start PostgreSQL with pgvector
docker-compose up -d postgres

# Setup database
npx prisma migrate dev
npx prisma db seed

# Start the app
npm run dev

🎮 First Steps

  1. Sign in with GitHub or Google (or configure another OAuth provider)
  2. Add some feeds - click the + button in the sidebar
  3. Read stuff - articles auto-refresh every 30 minutes
  4. Give feedback - thumbs up/down to train your personal AI
  5. Try semantic search - type naturally, get smart results

📸 Screenshots

Main Interface

Article Reading Panel

Split-pane reading interface

Article List View

Main article list with feed filtering

Full Page Article

Full-page article reading experience

Collapsed Sidebar

Compact sidebar for more reading space

Admin Dashboard

Admin Dashboard Overview

System statistics and health monitoring

Embeddings Management

Vector embeddings coverage and status

User Management

User roles and permissions

Cron Jobs

Background job execution and logs

Storage Management

Database and Redis storage metrics

System Configuration

Default preferences for new users

User Preferences & Customization

User Menu

Quick access to preferences and settings

Profile Settings

User profile and authentication info

Theme Selection

Multiple theme options (light, dark, and more)

Article Display Settings

Customize article density and visibility

Display Customization

Fine-tune borders and spacing

Reading Panel Config

Configure split-pane reading experience

Learning System

AI learning preferences and pattern detection

User LLM Settings

Personal LLM configuration and API keys

Theme Gallery

NeuReed comes with a variety of beautiful themes to match your style and mood:

Light Theme

Light

Dark Theme

Dark

Nord Light

Nord Light

Nord Dark

Nord Dark

Solarized Light

Solarized Light

Solarized Dark

Solarized Dark

Barbie Light

Barbie Light

Barbie Dark

Barbie Dark

Purple Light

Purple Light

Purple Dark

Purple Dark

Orange Light

Orange Light

Orange Dark

Orange Dark

Rainbow Light

Rainbow Light

Rainbow Dark

Rainbow Dark

Feed Management & Configuration

Feed Management

Advanced feed settings and organization

Admin LLM Config

System-wide LLM provider configuration

🎨 Features That'll Make You Happy

Smart Article Discovery

  • Semantic search: Find articles by meaning, not keywords
  • Saved searches: Create persistent queries that auto-match new articles
  • Related articles: Discover content similar to what you're reading
  • Personalized scoring: Articles ranked by how much you'll like them
  • Smart filtering: Hide read articles, filter by feed or category

Reading Experience

  • Three reading modes: Choose how you consume content
    • Side Panel: Split-screen with resizable panel (classic view)
    • Inline: Accordion-style expansion directly in the article list
    • Standalone: Full-page dedicated reading experience
  • Customizable fonts: Size, family, line height, spacing - all yours
  • Theme variety: Light, dark, Nord, Solarized, and more fun themes
  • Auto-scroll option: Automatically scroll to expanded articles in inline mode
  • Estimated reading time: Know before you commit

Feed Organization

  • Drag & drop: Organize feeds intuitively
  • Category management: Group feeds however makes sense to you
  • Per-feed settings: Different refresh rates, retention policies
  • OPML support: Import/export your subscriptions

Saved Searches (NEW!)

  • Dynamic feeds: Create searches that continuously monitor all your articles
  • Advanced syntax: Use AND/OR/NOT operators and grouped queries
  • Relevance scoring: See how well each article matches your query
  • Smart notifications: Get alerted only for high-relevance matches
  • Templates: Start quickly with pre-built search patterns
  • Mobile optimized: Swipe gestures, offline support, responsive design

AI-Powered Features

  • Article summaries: TL;DR powered by GPT
  • Embedding generation: Automatic or on-demand
  • Cost tracking: Know exactly what you're spending on AI
  • Provider flexibility: OpenAI, local models, or custom endpoints

Admin Dashboard

  • Cron job management: Monitor and trigger background tasks
  • Embedding stats: Track coverage and generation progress
  • User management: See who's using your instance
  • System health: Cache status, database stats, and more

📚 Documentation

🛠️ Tech Stack

We're standing on the shoulders of giants:

🤝 Contributing

Found a bug? Have an idea? Contributions are welcome!

# Fork the repo, then:
git clone https://github.com/YOUR_USERNAME/neureed.git
cd neureed
npm install
./scripts/setup.sh

# Create a feature branch
git checkout -b feature/amazing-feature

# Make your changes, commit, and push
git commit -m "Add some amazing feature"
git push origin feature/amazing-feature

# Open a PR!

📝 Environment Variables

Here's what you'll need for a basic setup:

# Database (required)
DATABASE_URL="postgresql://user:pass@localhost:5433/neureed"

# Auth (required for login)
NEXTAUTH_SECRET="generate-with-openssl-rand-base64-32"
NEXTAUTH_URL="http://localhost:3000"

# OAuth (pick at least one)
GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-secret"
GITHUB_CLIENT_ID="your-github-client-id"  
GITHUB_CLIENT_SECRET="your-github-secret"

# AI Features (optional but recommended)
OPENAI_API_KEY="sk-your-api-key"

# Redis (optional, but makes things faster)
REDIS_URL="redis://localhost:6379"

See Configuration Reference for the complete list.

🐛 Troubleshooting

Database connection fails?

  • Make sure PostgreSQL is running: docker-compose ps
  • Check the port (we use 5433 to avoid conflicts)

Build fails?

  • Clear node_modules and try again: rm -rf node_modules && npm install
  • Make sure you're on Node.js 24+: node --version

Embeddings not working?

  • Set your OpenAI API key or enable local embeddings
  • Check admin dashboard → Search tab for provider status

Still stuck? Check GitHub Issues or create a new one.

📜 License

MIT License - see LICENSE file for details. Build cool stuff with it!

🙏 Acknowledgments

  • Built with ❤️ by developers who got tired of crappy RSS readers
  • Inspired by the need for actually intelligent content discovery
  • Powered by the amazing open-source community

🌟 Star Us!

If NeuReed makes your RSS reading life better, give us a star! It helps others discover the project.


Ready to take control of your content? Get started now! 🚀

DocumentationReport BugRequest Feature

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors 2

  •  
  •  

Languages