From 191275f73b5d8f419f03c6efbdc63eb5b4723d84 Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Mon, 4 Aug 2025 09:05:32 +0000
Subject: [PATCH] Update README.md

---
 README.en.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 164 insertions(+)
 create mode 100644 README.en.md
 create mode 100644 README.md

diff --git a/README.en.md b/README.en.md
new file mode 100644
index 0000000..372a9b2
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,81 @@
+# flutter-we-easy
+
+flutter-we-easy is a Flutter-based application framework designed to streamline the development process for enterprise mobile applications. The framework provides a wide range of reusable components and modules, particularly suitable for business scenarios requiring complex user permission management, department management, role management, and user authentication features.
+
+## Project Structure Overview
+
+The project consists of two main directories:
+
+- **app**: Contains the main application code, including functionalities such as login, home page, theme management, initialization, and navigation control.
+- **common**: Provides cross-platform general modules, including enterprise-level features such as data loading, database connection, network requests, user authentication, department and role management.
+
+Additionally, the project supports **Android**, **iOS**, **OHOS**, and **Web** platforms, ensuring a consistent multi-device experience.
+
+## Key Features
+
+- **User Authentication and Login**: Offers complete login process support, including authentication APIs, middleware, and login status monitoring.
+- **Department Management**: Supports functionalities such as department creation, querying, and list display, suitable for applications with clear organizational structures.
+- **Role and Permission Management**: Implements enterprise-level features like role definition, permission assignment, and authorization management.
+- **Database Support**: Uses cross-platform database connections to support local data persistence.
+- **Network Request Tool**: Provides a unified HTTP request module, supporting header interception and unauthorized request handling.
+- **Theme and Settings Management**: Supports dynamic theme switching and application settings management.
+- **Common Components and Utilities**: Offers frequently used UI components and utility tools such as clickable text, safe areas, grid views, and key-value storage.
+
+## Technology Stack
+
+- Flutter (Cross-platform development)
+- Dart (Core language)
+- Kotlin (Android Native)
+- Swift (iOS Native)
+- ETS / OpenHarmony (OHOS Native)
+
+## Installation and Running
+
+### Prerequisites
+
+- Install Flutter SDK
+- Install platform-specific development tools such as Android Studio / XCode / OHOS DevEco Studio
+- Install Git
+
+### Steps
+
+1. Clone the project:
+   ```bash
+   git clone https://gitee.com/numeron/flutter-we-easy
+   ```
+
+2. Enter the project directory:
+   ```bash
+   cd flutter-we-easy
+   ```
+
+3. Get dependencies:
+   ```bash
+   flutter pub get
+   ```
+
+4. Run the project:
+   ```bash
+   flutter run
+   ```
+
+## Contribution Guide
+
+We welcome community contributions! You can participate in the following ways:
+
+- Submit bug reports or feature suggestions
+- Provide Pull Requests to improve code or documentation
+- Join discussions and help enhance the framework
+
+Please ensure that submitted code follows the project's coding standards and includes necessary test cases.
+
+## License
+
+This project follows the MIT License. For details, please refer to the [LICENSE](common/LICENSE) file.
+
+## Reference Documentation
+
+- [Flutter Official Documentation](https://flutter.dev/docs)
+- [OpenHarmony Developer Documentation](https://developer.harmonyos.com/)
+
+For more project details, please refer to the README.md files of specific modules or the project's commented code.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8c28f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,83 @@
+
+
+# flutter-we-easy
+
+flutter-we-easy 是一个基于 Flutter 的应用程序框架，旨在简化企业级移动应用的开发流程。该框架提供了大量可复用的组件和模块，尤其适用于需要复杂用户权限管理、部门管理、角色管理以及用户登录认证等功能的业务场景。
+
+## 项目结构概览
+
+该项目包含两个主要目录：
+
+- **app**: 包含应用程序的主代码，包括登录、首页、主题管理、初始化和导航控制等功能。
+- **common**: 提供了跨平台的通用模块，包含数据加载、数据库连接、网络请求、用户认证、部门和角色管理等企业级功能支持。
+
+此外，项目支持 **Android**, **iOS**, **OHOS** 和 **Web** 平台，确保多端一致性体验。
+
+## 主要功能
+
+- **用户认证与登录**: 提供完整的登录流程支持，包括认证 API、中间件、登录状态监听等。
+- **部门管理**: 支持部门的创建、查询、列表展示等功能，适用于组织架构清晰的应用。
+- **角色与权限管理**: 实现角色定义、权限分配、授权管理等企业级功能。
+- **数据库支持**: 使用多平台数据库连接，支持本地数据持久化。
+- **网络请求工具**: 提供统一的 HTTP 请求模块，并支持请求头拦截和未授权处理。
+- **主题与设置管理**: 支持动态切换主题、管理应用设置等功能。
+- **通用组件与工具**: 提供常用 UI 组件和实用工具，如点击文本、安全区域、网格视图、KV 存储等。
+
+## 使用技术栈
+
+- Flutter（跨平台开发）
+- Dart（核心语言）
+- Kotlin (Android 原生)
+- Swift (iOS 原生)
+- ETS / OpenHarmony (OHOS 原生)
+
+## 安装与运行
+
+### 前提条件
+
+- 安装 Flutter SDK
+- 安装 Android Studio / XCode / OHOS DevEco Studio 等对应平台开发工具
+- 安装 Git
+
+### 步骤
+
+1. 克隆项目：
+   ```bash
+   git clone https://gitee.com/numeron/flutter-we-easy
+   ```
+
+2. 进入项目目录：
+   ```bash
+   cd flutter-we-easy
+   ```
+
+3. 获取依赖：
+   ```bash
+   flutter pub get
+   ```
+
+4. 运行项目：
+   ```bash
+   flutter run
+   ```
+
+## 贡献指南
+
+我们欢迎社区贡献！你可以通过以下方式参与：
+
+- 提交 Bug 报告或功能建议
+- 提供 Pull Request 来改进代码或文档
+- 参与讨论并帮助改进框架
+
+请确保提交的代码遵循项目的代码规范，并提供必要的测试用例。
+
+## 协议
+
+本项目遵循 MIT 协议。详情请参阅 [LICENSE](common/LICENSE) 文件。
+
+## 参考文档
+
+- [Flutter 官方文档](https://flutter.dev/docs)
+- [OpenHarmony 开发文档](https://developer.harmonyos.com/)
+
+如需获取更多项目细节，请查看具体模块的 README.md 文件或项目注释代码。
\ No newline at end of file
-- 
Gitee