Skip to content

Commit

Permalink
feat: 调整自述文档
Browse files Browse the repository at this point in the history
  • Loading branch information
FoxSensei001 committed Dec 26, 2024
1 parent fb30d49 commit 64398e9
Show file tree
Hide file tree
Showing 7 changed files with 201 additions and 20 deletions.
113 changes: 94 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,104 @@
# i_iwara
# Love Iwara (2i)

A new Flutter project.
<p align="center">
<img src="assets/icon/launcher_icon_v2.png" width="200" alt="Love Iwara Logo">
</p>

## Getting Started
<div align="center">

This project is a starting point for a Flutter application that follows the
[simple app state management
tutorial](https://flutter.dev/to/state-management-sample).
[English](#english) | [中文](README_ZH.md)

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
</div>

## Assets
---

The `assets` directory houses images, fonts, and any other files you want to
include with your application.
## English

The `assets/images` directory contains [resolution-aware
images](https://flutter.dev/to/resolution-aware-images).
### 🌟 Introduction
Love Iwara (also known as i_iwara or 2i) is a third-party mobile application for Iwara, built with Flutter. Our goal is to provide an excellent user experience across all devices, from mobile phones to large screens.

## Localization
### ✨ Features
#### Current Features
- **🖥️ Support Platform**
- Android
- Windows
- MacOS (I dont have a Mac, so I can't test it and provide the builded package)
- Linux (I dont have a Linux Machine, so I can't test it and provide the builded package)
- iOS (I dont have an iOS Device, so I can't test it and provide the builded package)
- Web (Only for development use)
- **Video System**
- Video browsing and playback
- Video categories and tags
- Video quality selection
- Playback speed control
- Full-screen support

This project generates localized messages based on arb files found in
the `lib/src/localization` directory.
- **Image Gallery**
- Image browsing
- Image zoom and pan
- Gallery view

To support additional languages, please visit the tutorial on
[Internationalizing Flutter apps](https://flutter.dev/to/internationalization).
- **User System**
- User authentication
- Profile management
- Following system

- **Social Features**
- Comment system
- Like/Favorite functionality

- **Multi-language Support**
- English
- Chinese (Simplified)
- Chinese (Traditional)
- Japanese

#### Upcoming Features
- **Download Management**
- **Forum System**
- **Enhanced User Experience**

### 📱 Screenshots
<div align="center">
<img src="assets/show1.jpg" width="200" alt="Screenshot 1">
<img src="assets/show2.jpg" width="200" alt="Screenshot 2">
<img src="assets/show3.png" alt="Screenshot 3">
<img src="assets/show4.png" alt="Screenshot 4">
</div>

### 🛠️ Development Setup
```bash
# Clone the repository
git clone [repository-url]

# Install dependencies
flutter pub get

# Run the app
flutter run
```

### ⚠️ Important Notice
This project is a Flutter learning initiative intended for educational purposes only. Please note:

- **Educational Purpose**: This is a learning project as I'm new to Flutter development.
- **No Commercial Use**: Distribution or promotion on any platform is strictly prohibited. Violations may result in repository deletion or maintenance discontinuation.
- **Known Limitations**: As a learning project, it may contain significant issues including but not limited to:
- Performance issues
- Memory leaks
- Application freezes
- Other unexpected behaviors

### 🌍 Internationalization
Currently, the internationalization texts are generated using GPT. If you'd like to contribute to translations, please refer to the Simplified Chinese template at [lib/i18n/zh-CN.i18n.yaml](lib/i18n/zh-CN.i18n.yaml).

### 💬 Feedback
For suggestions or bug reports, please submit an issue in the repository's issue tracker.

### 🙏 Acknowledgments
This project wouldn't be possible without the inspiration and learning from these amazing projects:

- [iwrqk/iwrqk](https://github.com/iwrqk/iwrqk) - An excellent Flutter implementation of Iwara client
- [wgh136/PicaComic](https://github.com/wgh136/PicaComic) - A well-structured Flutter comic application

Many of the implementations and best practices in this project were learned from these repositories.
106 changes: 106 additions & 0 deletions README_ZH.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# Love Iwara (2i)

<p align="center">
<img src="assets/icon/launcher_icon_v2.png" width="200" alt="Love Iwara Logo">
</p>

<div align="center">

[English](README.md) | [中文](#中文)

</div>

---

## 中文

### 🌟 简介
Love Iwara(又名 i_iwara 或 2i)是一个使用 Flutter 构建的 Iwara 第三方移动应用。我们的目标是为所有设备(从手机到大屏幕)提供出色的用户体验。

### ✨ 功能特性
#### 当前功能
- **🖥️ 支持平台**
- Android
- Windows
- MacOS(由于没有 Mac 设备,暂无法测试以及提供构建好的安装包)
- Linux(由于没有 Linux 设备,暂无法测试以及提供构建好的安装包)
- iOS(由于没有 iOS 设备,暂无法测试以及提供构建好的安装包)
- Web(仅用于开发)

- **视频系统**
- 视频浏览和播放
- 视频分类和标签
- 视频质量选择
- 播放速度控制
- 全屏支持

- **图片库**
- 图片浏览
- 图片缩放和平移
- 图库视图

- **用户系统**
- 用户认证
- 个人资料管理
- 关注系统

- **社交功能**
- 评论系统
- 点赞/收藏功能

- **多语言支持**
- 英语
- 简体中文
- 繁体中文
- 日语

#### 即将推出的功能
- **下载管理**
- **论坛系统**
- **增强用户体验**


### 📱 截图展示
<div align="center">
<img src="assets/show1.jpg" width="200" alt="截图 1">
<img src="assets/show2.jpg" width="200" alt="截图 2">
<img src="assets/show3.png" alt="截图 3">
<img src="assets/show4.png" alt="截图 4">
</div>

### 🛠️ 开发设置
```bash
# 克隆仓库
git clone [仓库地址]

# 安装依赖
flutter pub get

# 运行应用
flutter run
```

### ⚠️ 重要说明
本项目是一个 Flutter 学习项目,仅供学习参考。请注意以下事项:

- **学习目的**:作为 Flutter 初学者的学习项目,仅供参考学习使用。
- **使用限制**:严禁在任何平台进行宣传推广。如有违反,将采取包括但不限于停止维护、删除仓库等措施。
- **已知问题**:由于项目属于学习性质,可能存在以下问题:
- 性能问题
- 内存溢出
- 应用假死
- 其他未能预料的情况

### 🌍 国际化
目前项目的国际化文本主要通过 GPT 生成。如果您愿意协助改进翻译,请参考简体中文模板文件:[lib/i18n/zh-CN.i18n.yaml](lib/i18n/zh-CN.i18n.yaml)

### 💬 反馈建议
如果您有任何建议或发现任何 bug,欢迎在项目的 issues 区提交反馈。

### 🙏 致谢
本项目的开发过程中受到了以下优秀项目的启发:

- [iwrqk/iwrqk](https://github.com/iwrqk/iwrqk) - 优秀的 Flutter 实现的 Iwara 客户端
- [wgh136/PicaComic](https://github.com/wgh136/PicaComic) - 结构良好的 Flutter 漫画应用

项目中的许多实现方式和最佳实践都是从这些仓库中学习得来。
Binary file added assets/show1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/show2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/show3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/show4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion lib/app/services/config_service.dart
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class ConfigService extends GetxService {
RENDER_VERTICAL_VIDEO_IN_VERTICAL_SCREEN: true.obs,
ACTIVE_BACKGROUND_PRIVACY_MODE: false.obs,
DEFAULT_LANGUAGE_KEY: 'zh-CN'.obs,
THEME_MODE_KEY: 0.obs, // 添加主题模式配置,默认为0(system)
THEME_MODE_KEY: 4.obs, // 添加主题模式配置,默认为0(system)
// TODO 远程仓库的 pubspec.yaml 地址
REMOTE_REPO_PUB_SPEC_YAML_URL: ''.obs,
// TODO 远程仓库的 release 地址
Expand Down

0 comments on commit 64398e9

Please sign in to comment.