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: 1 day 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 (about 1 month ago)
• Default Branch: main
• Last Pushed: 2025-01-21T07:45:25.000Z (3 days ago)
• Last Synced: 2025-01-21T08:27:54.556Z (3 days 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 built with React + Vite.

![preview](images/preview.png)

## ✨ 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:

```bash

docker run -d --name nextflux -p 3000:3000 --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.