https://github.com/collie-reader/collie
A minimal feed reader just for you
https://github.com/collie-reader/collie
atom atom-reader feed-reader rss rss-reader tauri-app
Last synced: 4 months ago
JSON representation
A minimal feed reader just for you
- Host: GitHub
- URL: https://github.com/collie-reader/collie
- Owner: collie-reader
- License: gpl-3.0
- Created: 2023-08-17T07:42:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-09T03:36:36.000Z (8 months ago)
- Last Synced: 2024-10-29T00:32:24.828Z (6 months ago)
- Topics: atom, atom-reader, feed-reader, rss, rss-reader, tauri-app
- Language: Rust
- Homepage:
- Size: 646 KB
- Stars: 177
- Watchers: 3
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Collie
Collie is a minimal RSS feed reader application. With Collie, you can:
- subscribe to multiple RSS/Atom feeds to organize your own news feed.
- receive a real-time notification when a new item is added to the subscribed feed. (By default, it is checked every 5 minutes.)
- and save the items to read again or later.
All you need is a local machine and the Internet. No virtual machine, no cloud infrastructures, no always-on database, and no account registration with privacy information required.
Collie is heavily inspired by [Miniflux](https://miniflux.app/) and [RSS app for Slack](https://gdgkr.slack.com/apps/A0F81R7U7-rss).
## Installation
Download the latest release for your system from [release page](https://github.com/parksb/collie/releases). Collie provides `.exe`/`.msi` files for Windows, `.app`/`.dmg` files for macOS, and `.deb`/`.AppImage` files for Linux.
On macOS, you can also install Collie via Homebrew:
```
$ brew install parksb/x/collie
```
## Screenshots
## Build
If you want to build Collie from source, you should get code by forking and cloning the git repository or downloading a zip file. After placing the source in your local environment, go to the project directory, and install front-end dependencies using pnpm. (If pnpm is not installed, [install pnpm](https://pnpm.io/installation) first.)
```
$ pnpm install
```
Then, run the following command to build.
```
$ pnpm tauri build
```
This command builds and installs your own Collie based on the cloned source. To develop and modify the application, learn more about [Tauri](https://tauri.app/).
The following diagram illustrates the overview of the architecture of Collie.
If you want to share the features that you developed yourself with others, please feel free to open an issue and send a pull request on this repository. All contributions are welcome :)
## Background
I've been getting tech news from HackerNews, Lobsters, etc. on Twitter (It's X now, but I'll keep calling it Twitter anyway), but many of them have been terminated due to changes in Twitter's API policy. I went from place to place: Bluesky, Mastodon, Slack, and newsletter. However, I couldn't settle anywhere. The social media services such as Bluesky and Mastodon had too many unnecessary features as news feed. Slack RSS was good to get the news in real-time, but the notifications mixed with other workspaces overwhelmed me. The newsletters gave me a lot of high-quality information, but not in real-time.
Then, I remembered Miniflux, the "minimalist and opinionated feed reader" that I had used past. This is the best option for my goal, but I had to pay for the hosted version or keep running docker machine on my local computer which did not have enough resources. Additionally, I didn't need a system that maintains multi-user sessions. Eventually, I had no choice but to create my own application, and that's why I made Collie, the minimal RSS reader just for me.
## License
Collie is distributed under the terms of the [GNU General Public License v3.0](LICENSE).