Tip
If you encounter any issues while using the application, please first check the Q&A page. If you cannot find a solution, feel free to report the issue in Issues.
- 🖥️ Cross-platform Support: Native desktop apps for Windows, macOS, and Linux, providing a smooth and consistent experience
- 🌐 Automatic Translation and Summary: Automatically translates article titles and content, and generates concise summaries to help you quickly grasp information
- 🔍 Smart Feed Discovery: Automatically discovers and recommends new RSS feeds from relevant sources, continuously enriching your reading library
- 🤖 AI-enhanced Features: Integrates advanced AI technology to empower various functions like translation, summarization, and recommendation, making reading smarter
- 🎨 Modern User Interface: Features a clean, beautiful, and responsive design, supports dark mode, providing a comfortable and immersive visual experience
- 📦 OPML Import/Export: Supports one-click import or export of OPML files, making it easy to migrate subscriptions from other RSS readers
- 🏭 Custom Scripts and Automation: Built-in filters, scripts, and XPath system, supporting highly customizable automation workflows
Download the latest installer for your platform from the Releases page:
Standard Installation:
- Windows:
MrRSS-{version}-windows-amd64-installer.exe/MrRSS-{version}-windows-arm64-installer.exe - macOS:
MrRSS-{version}-darwin-universal.dmg - Linux:
MrRSS-{version}-linux-amd64.AppImage/MrRSS-{version}-linux-arm64.AppImage
Portable Version (no installation required, all data in one folder):
- Windows:
MrRSS-{version}-windows-{arch}-portable.zip - Linux:
MrRSS-{version}-linux-{arch}-portable.tar.gz - macOS:
MrRSS-{version}-darwin-{arch}-portable.zip
Click to expand the build from source guide
Before you begin, ensure you have the following installed:
Platform-specific requirements:
- Linux: GTK3, WebKit2GTK 4.1, libsoup 3.0, GCC, pkg-config
- Windows: MinGW-w64 (for CGO support), NSIS (for installers)
- macOS: Xcode Command Line Tools
For detailed installation instructions, see Build Requirements
# Quick setup for Linux (Ubuntu 24.04+):
sudo apt-get install libgtk-3-dev libwebkit2gtk-4.1-dev libsoup-3.0-dev gcc pkg-config-
Clone the repository
git clone https://github.com/WCY-dt/MrRSS.git cd MrRSS -
Install frontend dependencies
cd frontend npm install cd ..
-
Install Wails v3 CLI
go install github.com/wailsapp/wails/v3/cmd/wails3@latest
-
Build the application
# Using Task (recommended) task build # Or using Makefile make build # Or directly with wails3 wails3 build
The executable will be created in the
build/bindirectory. -
Run the application
- Windows:
build/bin/MrRSS.exe - macOS:
build/bin/MrRSS.app - Linux:
build/bin/MrRSS
- Windows:
Normal Mode (default):
- Windows:
%APPDATA%\MrRSS\(e.g.,C:\Users\YourName\AppData\Roaming\MrRSS\) - macOS:
~/Library/Application Support/MrRSS/ - Linux:
~/.local/share/MrRSS/
Portable Mode (when portable.txt exists):
- All data stored in
data/folder
This ensures your data persists across application updates and reinstalls.
Click to expand the development guide
Start the application with hot reloading:
# Using Wails v3
wails3 dev
# Or using Task
task devWe provide a Makefile with common development tasks (works on Linux/macOS/Windows with Make installed):
# Show all available commands
make help
# Run full check (lint + test + build)
make check
# Clean build artifacts
make clean
# Setup development environment
make setupCross-platform scripts are available in the scripts/ directory:
Linux/macOS:
# Run all checks
./scripts/check.sh
# Pre-release checks
./scripts/pre-release.shWindows (PowerShell):
# Run all checks
.\scripts\check.ps1
# Pre-release checks
.\scripts\pre-release.ps1This project uses pre-commit hooks to ensure code quality:
# Install hooks
pre-commit install
# Run on all files
pre-commit run --all-files# Backend tests
go test ./...
# Frontend tests
cd frontend
npm testFor server deployments and API integration, use the headless server version:
# Using Docker (recommended)
docker run -p 1234:1234 mrrss-server:latest
# Or build from source
go build -tags server -o mrrss-server .
./mrrss-serverSee Server Mode Documentation for complete API reference and deployment guide.
We welcome contributions! Please see our Contributing Guidelines for details.
Before contributing:
- Read the Code of Conduct
- Check existing issues or create a new one
- Fork the repository and create a feature branch
- Make your changes and add tests
- Submit a pull request
If you discover a security vulnerability, please follow our Security Policy.
This project is licensed under the GPLv3 License - see the LICENSE file for details.
- Built with Wails - Go + Web framework
- UI powered by Vue.js 3 and Tailwind CSS
- Icons from Phosphor Icons
- RSS parsing with gofeed
- Issues: GitHub Issues
- Repository: github.com/WCY-dt/MrRSS
Made with ❤️ by the MrRSS Team
⭐ Star us on GitHub if you find this project useful!