tsacdop-podcast-app-android/README.md

73 lines
4.3 KiB
Markdown
Raw Normal View History

<p align="center">
2020-03-31 18:36:20 +02:00
<img src="https://raw.githubusercontent.com/stonega/tsacdop/master/android/app/src/main/res/mipmap-xhdpi/ic_notification.png" art = "Logo"/>
2020-03-14 04:27:44 +01:00
</br>
<img src="https://raw.githubusercontent.com/stonega/tsacdop/master/android/app/src/main/res/mipmap-xhdpi/text.png" art = "Tsacdop"/>
</p>
2020-02-09 13:13:56 +01:00
2020-04-21 10:41:38 +02:00
![CircleCI](https://img.shields.io/circleci/build/github/stonega/tsacdop?token=efe1331861e017144f2abb363acd95197e436dad)
2020-06-05 20:33:47 +02:00
2020-04-21 10:41:38 +02:00
![GitHub release (latest by date)](https://img.shields.io/github/v/release/stonega/tsacdop)
2020-06-05 20:33:47 +02:00
[![GooglePlay](https://img.shields.io/badge/Google-PlayStore-%2323CCC6)](https://play.google.com/store/apps/details?id=com.stonegate.tsacdop)
2020-04-21 10:41:38 +02:00
## About
2020-06-05 20:33:47 +02:00
2020-02-12 14:09:03 +01:00
Enjoy podcasts with Tsacdop.
2020-04-03 08:25:04 +02:00
Tsacdop is a podcast player developed with flutter, a clean, simply beautiful and friendly app, only support Android right now.
2020-02-09 13:42:33 +01:00
2020-04-03 08:25:04 +02:00
Credit to flutter team and all involved plugins, especially [webfeed](https://github.com/witochandra/webfeed) and [Just_Audio](https://pub.dev/packages/just_audio).
2020-02-09 13:42:33 +01:00
2020-02-11 14:01:57 +01:00
The podcasts search engine is powered by [ListenNotes](https://listennotes.com).
2020-03-14 04:27:44 +01:00
2020-04-03 08:25:04 +02:00
## Features
2020-06-05 20:33:47 +02:00
2020-06-02 16:05:49 +02:00
* Podcasts group management
2020-04-03 08:25:04 +02:00
* Playlist support
2020-05-18 19:03:45 +02:00
* Sleep timer / Speed setting
2020-04-03 08:25:04 +02:00
* OMPL file export and import
* Auto syncing in background
* Listen and subscribe history record
2020-05-18 19:03:45 +02:00
* Dark mode / Accent color
* Download for offline playing
2020-06-02 16:05:49 +02:00
* Share clip(video format) on twitter
2020-04-03 08:36:14 +02:00
2020-04-03 08:25:04 +02:00
More to come...
2020-04-03 08:36:14 +02:00
## Preview
2020-06-05 20:33:47 +02:00
| HomePage | Group | Podcast | Episode | DarkMode |
|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| <img src="https://raw.githubusercontent.com/stonega/tsacdop/master/preview/1585893838840.png" art = "HomePage"/> | <img src="https://raw.githubusercontent.com/stonega/tsacdop/master/preview/1585894051734.png" art = "Groups"/> | <img src="https://raw.githubusercontent.com/stonega/tsacdop/master/preview/1585893877702.png" art = "Podcast"/> | <img src="https://raw.githubusercontent.com/stonega/tsacdop/master/preview/1585896237809.png" art = "Episode"/> | <img src="https://raw.githubusercontent.com/stonega/tsacdop/master/preview/1585893920721.png" art = "DarkMode"/> |
2020-04-03 08:36:14 +02:00
2020-02-12 14:18:20 +01:00
## License
2020-03-31 18:36:20 +02:00
Tsacdop is licensed under the [GPL V3.0](https://github.com/stonega/tsacdop/blob/master/LICENSE) license.
2020-02-12 14:09:03 +01:00
2020-04-21 10:41:38 +02:00
## Build
Tsacdop is using ListenNotes api 1.0 pro to search podcast, which is not free. So I can not expose the api key in the repo.
If you want to build the app, you need to create a new file named .env.dart in lib folder. Add below code in .env.dart.
2020-06-06 06:58:54 +02:00
```
2020-06-05 20:33:47 +02:00
final environment = {"apiKey":"APIKEY", "shareKey":"SHAREKEY"};
2020-04-21 10:41:38 +02:00
```
2020-06-05 20:33:47 +02:00
You can get own api key on [ListenNotes](https://www.listennotes.com/api/), basic plan is free to all, and replace "APIKEY" with it.
2020-04-21 10:41:38 +02:00
If no api key added, the search function in the app won't work. But you can still add podcasts by serach rss link or import ompl file.
2020-05-18 19:03:45 +02:00
Share_key is used for generate clip.
2020-02-09 13:13:56 +01:00
## Getting Started
This project is a starting point for a Flutter application.
A few resources to get you started if this is your first Flutter project:
2020-06-05 20:33:47 +02:00
* [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
* [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
2020-02-09 13:13:56 +01:00
For help getting started with Flutter, view our
2020-06-05 20:33:47 +02:00
[online documentation](https://flutter.dev/docs), which offers tutorials,
2020-02-09 13:13:56 +01:00
samples, guidance on mobile development, and a full API reference.