A cross-platform academic assistant application built with Flutter, based on the open-source project gpt_academic.
This project aims to create a powerful, cross-platform (iOS, Android, Windows, macOS, Linux) academic assistant. It leverages the core functionalities of the gpt_academic project, providing a modern and responsive user interface built with Flutter.
- Multi-LLM Support: Unified interface for various Large Language Models including OpenAI GPT, Anthropic Claude, and local models via Ollama.
- Document Processing: Tools for PDF/LaTeX paper translation, proofreading, and summarization.
- Code Analysis: Features for analyzing and understanding codebases in various languages.
- Plugin System: A modular architecture that allows for the easy addition of new functionalities.
- Real-time Chat: A familiar chat interface with support for Markdown, code highlighting, and conversation history.
- Framework: Flutter 3.x & Dart 3.x
- Architecture: Feature-first approach
- State Management: Riverpod
- Dependency Injection: get_it
- Routing: go_router
- Networking: Dio, Retrofit
- Local Storage: Hive, flutter_secure_storage
- Flutter SDK (version 3.x or higher)
- An IDE such as VS Code or Android Studio
-
Clone the repository:
git clone <repository-url> cd gpt_academic_assist_flutter
-
Install dependencies:
flutter pub get
-
Run the code generator:
dart run build_runner build --delete-conflicting-outputs
-
Configure API Keys:
- Launch the application.
- Navigate to the Settings page.
- Enter your API keys for the desired LLM services.
-
Run the application:
flutter run
This project is licensed under the GPLv3 License.
It is a derivative work of the gpt_academic project, which is also licensed under GPLv3. In compliance with the license, this project maintains the same open-source spirit and licensing terms.
This README was generated based on the project development guidelines.