Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msasikanth/twine
Twine: A multiplatform RSS reader built using Kotlin and Compose
https://github.com/msasikanth/twine
compose-multiplatform kotlin-multiplatform
Last synced: 24 days ago
JSON representation
Twine: A multiplatform RSS reader built using Kotlin and Compose
- Host: GitHub
- URL: https://github.com/msasikanth/twine
- Owner: msasikanth
- License: apache-2.0
- Created: 2023-04-26T08:01:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-04T16:30:05.000Z (3 months ago)
- Last Synced: 2024-08-04T23:06:23.336Z (3 months ago)
- Topics: compose-multiplatform, kotlin-multiplatform
- Language: Kotlin
- Homepage:
- Size: 20.9 MB
- Stars: 1,629
- Watchers: 11
- Forks: 70
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-kotlin-multiplatform - reader
- my-awesome-github-stars - msasikanth/twine - Twine: A multiplatform RSS reader built using Kotlin and Compose (Kotlin)
- awesome-list - msasikanth/twine - Twine: A multiplatform RSS reader built using Kotlin and Compose (Kotlin)
README
# Twine - RSS Reader
![CI-MAIN](https://github.com/msasikanth/twine/actions/workflows/ci_checks.yml/badge.svg?branch=main)
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/msasikanth)![banner](./readme_images/banner.png)
Twine is a multiplatform RSS reader app built using Kotlin and Compose Multiplatform. It features an nice
user interface and experience to browse through the feeds, and supports Material 3 content based
[dynamic theming](https://m3.material.io/styles/color/dynamic-color/user-generated-color).## Download
## Screenshots
## Features ✨
- Supports RSS & Atom feeds
- Feed management: Add, Edit & Pin feeds
- Feed grouping
- Access to pinned feeds/groups from bottom bar
- Smart fetching: Twine looks for feeds when given any website homepage
- Article shortcut to fetch full article in reader view
- Bookmark posts to read later
- Search posts
- Background sync
- Import and exports your feeds with OPML
- Dynamic content theming
- Light/Dark mode support## Tech Stack 📚
- [Kotlin Multiplatform](https://kotlinlang.org/lp/multiplatform/)
- [Kotlin Coroutines](https://github.com/Kotlin/kotlinx.coroutines)
- [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/)
- [Ktor](https://ktor.io/)
- [SQLDelight](https://cashapp.github.io/sqldelight/2.0.0-alpha05/)
- [Decompose](https://arkivanov.github.io/Decompose/)
- [Kotlin-inject](https://github.com/evant/kotlin-inject)For full list of dependencies used, please take a look at the [catalog](/gradle/libs.versions.toml) file.
## Development 🛠️
You can just clone the repo and build it locally without requiring any changes.
Project requires JDK 20+, and based on the AGP version defined in [`libs.versions.toml`](/gradle/libs.versions.toml) file,
you can use appropriate Android Studio to import the project.## Contributing 🛠️
You can contribute bug fixes to the project via PRs, for anything else open an issue to start a conversation.
This project uses ktfmt, provided via the spotless gradle plugin, and the bundled project IntelliJ codestyle. Run
`./gradlew spotlessApply` to format the code before raising a PR.## Made by ❤️
- [Sasikanth Miriyampalli](https://www.sasikanth.dev) / Development
- [Eduardo Pratti](https://twitter.com/edpratti) / Design## Error Reporting by
## License
```
Copyright Sasikanth MiriyampalliLicensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License athttps://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```