https://github.com/a-chacon/chaski-app

A beautifully designed, privacy-focused feed reader that keeps you updated.
https://github.com/a-chacon/chaski-app

atom feed linux macos news react rss rust tauri tauri-app windows

Last synced: 3 days ago
JSON representation

A beautifully designed, privacy-focused feed reader that keeps you updated.

• Host: GitHub
• URL: https://github.com/a-chacon/chaski-app
• Owner: a-chacon
• License: gpl-3.0
• Created: 2024-12-14T23:28:43.000Z (11 days ago)
• Default Branch: main
• Last Pushed: 2024-12-22T20:21:19.000Z (3 days ago)
• Last Synced: 2024-12-22T20:32:27.863Z (3 days ago)
• Topics: atom, feed, linux, macos, news, react, rss, rust, tauri, tauri-app, windows
• Language: TypeScript
• Homepage: https://chaski.a-chacon.com/
• Size: 15.6 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


  

  


  Chaski

  






  A beautifully designed, privacy-focused feed reader that keeps you updated.
 Build on the top of

  Tauri.





  





  Key Features •

  Download •

  Contribute •

  License



## Support



# Key Features

- **Privacy First**: No ads, telemetry, or any data leaving your device.

- **Auto-discovery of RSS/Atom**: The app will automatically find the URL when possible.

- **Modern UI**: A clean, soft, and modern interface that helps you focus on reading without distractions.

- **Dark/Light Mode**: Switch between dark and light modes for optimal viewing.

- **Import/Export OPML**: Import and export your feeds in OPML format.

- **Organize Feeds in Folders**: Categorize your feeds for better organization.

- **Customizable Filters**: Configure custom filters for each feed.

- **New Entry Notifications**: Get notified when new content is available.

- **Configurable Fonts**: Choose and customize your preferred fonts for reading.

- **Built with Tauri**: A cross-platform app that works on Linux, Windows, and macOS. Android support coming soon.

- **Full-Text Search**: Search through your articles with ease.

- **Read Full Articles**: View the complete text of articles directly in the app.

- **Offline Mode**: Access your content even when you're offline.

- **User Feedback**: I read and value your feedback to improve the app further!

### On the Roadmap

- **Multilingual Support**: Adding at least Spanish language support.

- **Android Version**: Compile and release for Android.

- **Google News Sitemap Support**: Support for news sites that don't have an RSS/Atom feed but offer Google News sitemaps.

## Download

You can [download](https://github.com/a-chacon/chaski/releases/latest) the latest installable version of Chaski for Windows, macOS and Linux.

## Contributing

Contributions are welcome! If you find any issues or have ideas for new features, feel free to open an issue or submit a pull request. For feature requests, it's a good idea to discuss them beforehand to ensure they're aligned with the app's goals.

### Disclaimer

Please note that the codebase is still in an early stage. It was initially created as a learning project to explore Rust and solve my own needs. As such, the code is "dirty" and lacks proper tests (which will be added in the near future).

The project is open to large refactors and improvements. If you're interested in contributing, feel free to dive into the code, suggest improvements, or help clean it up.

### Prerequisites

- Install Node.js. I recommend you to use [NVM](https://github.com/nvm-sh/nvm).

- Install yarn. [Here](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable) is the manual.

- Install Rust. You can find way in [here](https://www.rust-lang.org/tools/install)

- Follow the [Tauri setup guide](https://v2.tauri.app/start/prerequisites/)

- Run yarn install

### Develop

It is easy to start developing

```bash

yarn tauri dev

```

## License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.