https://github.com/electh/nextflux
Yet another web-based frontend for Miniflux
https://github.com/electh/nextflux
feed feed-reader miniflux rss rss-reader
Last synced: 6 months ago
JSON representation
Yet another web-based frontend for Miniflux
- Host: GitHub
- URL: https://github.com/electh/nextflux
- Owner: electh
- Created: 2024-12-11T14:16:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-21T07:45:25.000Z (about 1 year ago)
- Last Synced: 2025-01-21T08:27:54.556Z (about 1 year ago)
- Topics: feed, feed-reader, miniflux, rss, rss-reader
- Language: JavaScript
- Homepage: https://nextflux.pages.dev/
- Size: 39.7 MB
- Stars: 110
- Watchers: 1
- Forks: 13
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nextflux
A modern RSS reader client for [Miniflux](https://github.com/miniflux/v2) built with React + Vite.
## ✨ 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 & French)
- 👀 Mark as read on scroll
- 🎯 Rich reading experience
- Custom font settings
- Image gallery with touch gestures support
- Podcast player with speed control and background playback support
- Video player with beautiful UI
- Save article to 3rd party services
- ⌨️ Keyboard shortcuts
- 📊 Feed management
- OPML import
- Category organization
- Feed hiding
- Feed discovery and search
- Advanced options for feed management
## 📸 Screenshot Galleries
Podcast
YouTube
Code Highlight
Image Gallery
Feed Discovery
Settings
Stone theme
Responsive
Search
Dark Mode
Advanced Options
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:
```bash
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](./compose.yml) and replace the passwords, then run:
```bash
docker compose up -d
```
## 📝 Configuration
The app requires a Miniflux server to function. You'll need to provide:
- Server URL
- API Token / Username and 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
- 🇹🇷 Turkish: [@TaylanTatli](https://github.com/TaylanTatli)
- 🇫🇷 French: [@quent1-fr](https://github.com/quent1-fr)