Skip to content

README.md

Latest commit

 

History

History
137 lines (95 loc) · 3.91 KB

README.md

File metadata and controls

137 lines (95 loc) · 3.91 KB
Raw

📚 Olib

Flutter Dart AI Built Open Source License

🤖 An open-source ebook reader built entirely with AI assistance

Third-party client • Frontend interface only • All data from external sources

Download • Report Bug • Request Feature

English | 简体中文 | 日本語 | 한국어

⚠️ Disclaimer: Olib is an independent, open-source third-party client. It is NOT an official client and is not affiliated with any official service. This project only provides the frontend interface - all book data comes from external sources. Use at your own discretion.

✨ Features

Feature Description
📖 Book Search Search books by title, author, ISBN, or keywords
💾 Offline Reading Download books for reading without internet
🌙 Dark Mode Eye-friendly reading experience
🌍 Multi-language Supports 16+ languages including English, 中文, 日本語, 한국어
🔐 Multi-Account Switch between multiple accounts seamlessly
🔗 Multi-Domain Choose from multiple server lines
🆓 100% Free No ads, no subscriptions, no hidden costs

🤖 AI-Built Project

This project was built entirely with AI assistance:

  • Architecture design by AI
  • Code implementation by AI
  • UI/UX design by AI
  • Documentation by AI

📱 Screenshots

Coming soon...

🚀 Quick Start

Prerequisites

  • Flutter SDK 3.8+
  • Android Studio / VS Code
  • Android device or emulator

Installation

# Clone the repository
git clone https://github.com/shiyi-0x7f/olib-mobile.git

# Navigate to project directory
cd olib-mobile

# Install dependencies
flutter pub get

# Run the app
flutter run

Build APK

flutter build apk --release

🏗️ Project Structure

lib/
├── l10n/           # Localization files (16+ languages)
├── models/         # Data models
├── providers/      # State management (Riverpod)
├── routes/         # App navigation
├── screens/        # UI screens
├── services/       # API & storage services
├── theme/          # App theme configuration
└── widgets/        # Reusable components

🛠️ Tech Stack

  • Framework: Flutter
  • State Management: Riverpod
  • Local Storage: Hive
  • HTTP Client: http package
  • Localization: 16+ languages

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

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

⚠️ Legal Notice:

  • This is an independent third-party client, NOT an official application
  • All book data comes from external sources; this project provides frontend only
  • Users are responsible for ensuring compliance with applicable laws
  • By using this software, you acknowledge these terms

💖 Acknowledgments

  • 🤖 Built with AI assistance
  • 💙 Flutter framework
  • ❤️ Open source community

⬆ Back to Top

Built with 🤖 AI • Open Source • Free Forever