Skip to content

electh/nextflux

Folders and files

NameName
Last commit message
Last commit date
Jan 17, 2025
Jan 17, 2025
Jan 17, 2025
Feb 24, 2025
Jan 23, 2025
Dec 11, 2024
Jan 23, 2025
Jan 23, 2025
Feb 4, 2025
Jan 23, 2025
Dec 11, 2024
Jan 29, 2025
Dec 11, 2024
Feb 24, 2025
Feb 24, 2025
Dec 11, 2024
Feb 16, 2025
Dec 11, 2024

Repository files navigation

Nextflux

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

preview

โœจ Features

  • ๐Ÿš€ Fast and responsive UI built with HeroUI (Previously 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 & Turkish)
  • ๐Ÿ‘€ 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
  • HeroUI (Previously NextUI)
  • i18next
  • IndexedDB
  • Nanostores
  • DayJS

๐Ÿš€ Deployment

Docker Deployment (standalone)

Run with Docker using the following command:

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

Cloudflare Pages Deployment (standalone)

  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

Docker Compose Deployment (with Miniflux)

To deploy with Miniflux, copy docker compose file and replace the passwords, then run:

docker compose up -d

๐Ÿ“ 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

Do whatever the heck you want with itโ€”just donโ€™t come crying to me if it messes up your stuff. Just kidding (or not), but seriously, itโ€™s all yours.

๐Ÿ“š FAQ

1. My scrollbar looks like shit in Windowsโ€”how do I fix this?

If youโ€™re using Microsoft Edge, head over to the edge://flags page and enable the Fluent overlay scrollbars option. Chrome might have something similar lurking around.

2. Are there any plans to support Fever or Google Reader APIs?

Nope, sorry folks. For now, Iโ€™m all in on the Miniflux APIโ€”gotta pick my battles.

3. Why does it resemble Reeder so much?

Reeder is a fantastic RSS reader. Since my design skills are about as good as a potato's, I took some "inspiration" from its UI style, slapped it on, and called it a day.

4. Any plans to add AI features like article summarization and translation?

There are so many chrome extensions that can do this. I'm not sure if I want to build this into the app. Tell me what you think by opening an issue.

๐ŸŒ Translation

Contributor