Skip to content

electh/nextflux

Repository files navigation

Nextflux

A modern RSS reader client for Miniflux built with React + Vite.

preview

✨ Features

  • 🚀 Fast and responsive UI built with NextUI
  • 🌐 Connect to your Miniflux server
  • 🔄 Automatic background sync with configurable intervals
  • 📱 Mobile-friendly with PWA support
  • 🌙 Light/Dark mode with multiple theme options
  • 🌍 i18n support (English & Chinese)
  • 👀 Mark as read on scroll
  • 🎯 Rich reading experience
    • Custom font settings
    • Image gallery with touch gestures support
    • Podcast support
    • Video player support
  • ⌨️ Keyboard shortcuts
  • 📊 Feed management
    • OPML import
    • Category organization
    • Feed hiding

📸 Screenshot Galleries

Podcast YouTube
Code Highlight Image Gallery
Feed Management Settings
Stone theme Responsive
Search Dark Mode
Mobile Windows

🛠️ Tech Stack

  • React 18
  • Vite
  • TailwindCSS
  • NextUI
  • i18next
  • IndexedDB
  • Nanostores
  • DayJS

🚀 Deployment

Docker Deployment

Run with Docker using the following command:

docker run -d --name nextflux -p 80:80 --restart unless-stopped electh/nextflux:latest

Cloudflare Pages Deployment

  1. Fork this repository to your GitHub account
  2. Create a new project in Cloudflare Pages
  3. Select your forked repository
  4. Select Framework preset: React(Vite)
  5. Set build command: npm run build
  6. Set build output directory: dist
  7. Deploy and access through the Cloudflare-assigned domain

📝 Configuration

The app requires a Miniflux server to function. You'll need to provide:

  • Server URL
  • Username
  • Password

🌍 Browser Support

  • Chrome (recommended)
  • Firefox
  • Safari
  • Edge

📱 Mobile Support

The app is fully responsive and works well on mobile devices. It can also be installed as a PWA for a native app-like experience.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.