ReactFlux

Read in other languages: Deutsch, Español, Français, 简体中文

Overview

ReactFlux is a third-party web frontend for Miniflux, aimed at providing a more user-friendly reading experience.

Key features include:

• Modern interface design
• Responsive layout with touch gestures support
• Support for dark mode and custom themes
• Customizable reading experience:
  • Font family and size settings
  • Article width adjustment
  • Title alignment options
  • Image viewer with zoom and slideshow
  • Footnotes enhancement
  • Code syntax highlighting
  • Estimated reading time
• Article and feed management:
  • Google-like syntax for search
  • Filter articles by read status, publish date, title, content, or author
  • Batch operations for feeds
  • Full-text fetching support
  • De-duplicate articles by hash, title, or URL
  • Auto mark articles as read while scrolling
• Advanced features:
  • Keyboard shortcuts (customizable)
  • Batch update the host of filtered subscription URLs (useful for replacing RSSHub instances)
  • Batch refresh errored subscriptions
  • Save articles to third-party services
• I18n supports (Deutsch / English / Español / Français / 简体中文)
• Other features waiting for you to discover...

Online Demo & Screenshots

Try ReactFlux with our online demo instance.

See how ReactFlux looks in different themes:

Quick Start

1. Ensure you have a working Miniflux instance
2. Directly use our online demo instance or deploy ReactFlux using one of the methods below
3. Log in using your Miniflux username and password or API key (recommended)

Deployment

Cloudflare Pages

ReactFlux is built with React and generates a set of static web files after building, which can be directly deployed on Cloudflare Pages.

You can deploy it on Cloudflare Pages by selecting Framework preset as Create React App.

Using Pre-built Files

You can download the pre-built files from the gh-pages branch and deploy them to any static hosting service that supports single-page applications (SPA).

Make sure to configure URL rewriting to redirect all requests to index.html.

If you are deploying using Nginx, you might need to add the following configuration:

location / {
    try_files $uri $uri/ /index.html;
}

Vercel

Docker

docker run -p 2000:2000 electh/reactflux

Or using Docker Compose:

docker-compose up -d

Translation Guide

To help us translate ReactFlux into your language, please contribute to the locales folder and send a pull request.

Additionally, you need to add a README file for the respective language and reference it in all existing README files.

You should also modify parts of the source code to include the i18n language packages for Arco Design and Day.js.

For detailed changes, please refer to the modifications in PR #145.

Current Translators

Contributors

Thanks to all the contributors who have made this project more awesome!

Made with contrib.rocks.

Star History