Skip to content

shadowfish07/ReadeckAPP

Repository files navigation

ReadeckApp

English | 中文

License: MIT Version CodeRabbit Pull Request Reviews codecov

A read-later mobile application built as a companion app for Readeck.

About

Readeck is an excellent read-later project, but it doesn't provide mobile support. ReadeckApp aims to serve as its mobile companion, providing users with a convenient mobile read-later tool. Additionally, ReadeckApp extends functionality based on Readeck data, including daily reading features, AI translation, and more.

✨ Features

  • 📱 Daily Reading: Daily random selection of 5 unarchived articles with potential data visualization
  • 🌐 Full Readeck Support: Supports all Readeck web features (in development)
  • 🔒 Complete Privacy: No data sent to third parties - your data stays private
  • 📊 Readeck-First Architecture: Prioritizes Readeck data with appropriate local caching, avoiding data sync issues
  • 🤖 AI Features: AI translation, AI tagging, and more
  • 📱 Android Native: Built with Flutter for smooth Android experience

📋 Prerequisites

Before using ReadeckApp, you need to deploy your own Readeck instance. Follow the official Readeck documentation for setup instructions.

📦 Installation

Download APK

  1. Go to the GitHub Releases page
  2. Download the latest APK file
  3. Install the APK on your Android device

Google Play Store release is planned for the future.

Build from Source

# Clone the repository
git clone [email protected]:shadowfish07/ReadeckAPP.git
cd ReadeckApp

# Install dependencies
flutter pub get

# Run the app
flutter run

🛠️ Tech Stack

  • Framework: Flutter
  • Key Libraries:
    • go_router - Navigation
    • sqflite - Local database
    • freezed - Code generation
    • result_dart - Error handling
    • dio_socket_client - Network requests
    • flutter_command - Command pattern
    • flutter_html - HTML rendering

🗺️ Roadmap

  • Enhanced AI functionality
  • Improved daily recommendations and summaries
  • Google Play Store release
  • iOS support
  • Reading analytics and visualizations

🐛 Known Issues

This project is currently in early development stage. Please report any issues you encounter.

🤝 Contributing

Contributions are welcome! Please refer to .trae/rules/project_rules.md for detailed contribution guidelines.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Readeck - The excellent read-later service that inspired this project
  • Flutter community for the amazing framework and packages

Activity

Alt

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 6