diff --git a/README.md b/README.md index 351b59c..3b2a6b0 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,241 @@ -# Cool Unix +
+ +# 🚀 Cool Unix -Cool Unix 是一个现代化的跨端应用开发脚手架,基于 uni-app x 技术栈,为开发者提供了完整的解决方案,助力快速构建高质量、高性能的跨平台应用。 +**基于 uni-app x 的现代化跨端应用开发脚手架** -- **Service 服务** - 统一的 API 请求管理 -- **uvue 组件库** - 原生级别的组件性能 -- **Tailwind CSS** - 实用优先的 CSS 框架 -- **多主题支持** - 自由切换主题色彩 -- **深色模式** - 适配用户偏好设置 -- **多语言切换** - 国际化应用必备 -- **图标自动导入** - 支持 Iconfont 和 Remixicon -- **微信小程序登录** - 无缝对接微信生态 -- **APP 微信登录** - 第三方授权登录 -- **一键登录** - 运营商快速登录 -- **短信验证码** - 传统可靠的登录方式 -- **本地存储** - 简单直接的文件管理 -- **七牛云** - 专业的对象存储服务 -- **阿里云 OSS** - 稳定可靠的存储方案 -- **腾讯云 COS** - 高性能存储服务 +_一次开发,全端运行 - 为您的创新想法提供最强大的技术底座_ -## 快速开始 +[![GitHub license](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://github.com/cool-team-official/cool-unix/blob/master/LICENSE) +[![GitHub release](https://img.shields.io/github/package-json/v/cool-team-official/cool-unix?style=flat-square&color=blue)](https://github.com/cool-team-official/cool-unix/releases) +[![GitHub stars](https://img.shields.io/github/stars/cool-team-official/cool-unix?style=flat-square&color=yellow)](https://github.com/cool-team-official/cool-unix/stargazers) +[![GitHub forks](https://img.shields.io/github/forks/cool-team-official/cool-unix?style=flat-square&color=orange)](https://github.com/cool-team-official/cool-unix/network) +[![Last commit](https://img.shields.io/github/last-commit/cool-team-official/cool-unix?style=flat-square&color=red)](https://github.com/cool-team-official/cool-unix/commits) -### 开发环境推荐 + + Cool Unix Logo + -- **代码编辑器**:[Cursor](https://cursor.com/cn) - AI 驱动的智能编辑器,提供强大的代码提示和生成功能 -- **运行调试工具**:[HBuilderX](https://www.dcloud.io/hbuilderx.html) - 专为 uni-app 优化的集成开发环境 +[📖 在线文档](https://unix.cool-js.com/) · [🎯 快速开始](#-快速开始) · [✨ 特性展示](#-核心特性) · [🌟 在线预览](https://unix.cool-js.com/demo) -### 获取项目代码 +--- -```shell +
+ +## 📋 目录 + +- [🌟 项目概述](#-项目概述) +- [🚀 平台兼容性](#-平台兼容性) +- [✨ 核心特性](#-核心特性) +- [🎯 快速开始](#-快速开始) +- [🛠️ 技术栈](#️-技术栈) +- [🤝 参与贡献](#-参与贡献) +- [📄 开源协议](#-开源协议) + +## 🌟 项目概述 + +Cool Unix 是一个企业级的跨端应用开发脚手架,基于最新的 **uni-app x** 技术栈构建。它不仅仅是一个模板项目,更是一个完整的开发生态系统,为现代化应用开发提供了从架构设计到部署上线的全流程解决方案。 + +### 🎯 设计理念 + +- **🏗️ 架构优先**:基于现代化的分层架构设计,确保代码的可维护性和可扩展性 +- **⚡ 性能驱动**:原生级别的运行性能,为用户提供流畅的使用体验 +- **🔧 开发友好**:完善的开发工具链和丰富的组件库,大幅提升开发效率 +- **🌐 生态完整**:一站式解决方案,涵盖认证、存储、UI、主题等各个方面 + +## 🚀 平台兼容性 + +
+ +| 平台 | 支持状态 | 最低版本 | 特性支持 | +| :---------------: | :---------: | :------------: | :------------------: | +| 🍎 **iOS** | ✅ 完整支持 | iOS 9.0+ | 原生性能、推送、支付 | +| 🤖 **Android** | ✅ 完整支持 | Android 5.0+ | 原生性能、推送、支付 | +| 🦋 **鸿蒙 OS** | ✅ 完整支持 | HarmonyOS NEXT | 原生性能、系统集成 | +| 🌐 **Web** | ✅ 完整支持 | 现代浏览器 | PWA、响应式设计 | +| 💬 **微信小程序** | ✅ 完整支持 | 最新版本 | 微信生态集成 | + +
+ +## ✨ 核心特性 + +### 🏗️ **企业级架构** + +``` +📁 分层架构设计,职责清晰 +🔄 统一的状态管理 +🎯 Service层API封装 +📦 模块化组件设计 +``` + +### ⚡ **极致性能** + +``` +🚀 uni-app x 原生渲染 +📱 接近原生应用性能 +⚙️ 智能编译优化 +💾 高效的缓存策略 +``` + +### 🎨 **视觉体验** + +``` +🎯 Cool UI 组件库(100+ 组件) +🌈 Tailwind CSS 工具类 +🌙 深色模式支持 +🎨 多主题动态切换 +📱 响应式设计适配 +``` + +### 🔐 **认证体系** + +``` +📱 微信小程序一键登录 +🔑 APP 微信授权登录 +📞 运营商一键登录 +📩 短信验证码登录 +🔒 JWT Token 管理 +``` + +### ☁️ **云服务集成** + +``` +📁 本地文件存储 +🗂️ 七牛云对象存储 +☁️ 阿里云 OSS +🌥️ 腾讯云 COS +🔄 多云存储切换 +``` + +### 🎛️ **开发工具** + +``` +🎯 图标自动导入(Iconfont + Remixicon) +🔍 智能代码提示 +🔄 多语言AI自动翻译 +``` + +## 🎯 快速开始 + +### 💻 开发环境推荐 + +我们推荐使用以下开发环境以获得最佳的开发体验: + +| 工具 | 推荐版本 | 用途 | 特色功能 | +| :---------------------------------------------------: | :------: | :------: | :-------------------: | +| **[Cursor](https://cursor.com/cn)** | 最新版 | 代码编辑 | AI 代码生成、智能提示 | +| **[HBuilderX](https://www.dcloud.io/hbuilderx.html)** | 4.0+ | 运行调试 | uni-app 专用 IDE | +| **Node.js** | 18+ | 运行环境 | LTS 版本 | +| **pnpm** | 8+ | 包管理器 | 更快、更节省空间 | + +### 🚀 一键启动 + +```bash +# 📥 克隆项目 git clone https://github.com/cool-team-official/cool-unix.git + +# 📂 进入项目目录 +cd cool-unix + +# 📦 安装依赖(推荐使用 pnpm) +pnpm install + +# 🎉 使用 HBuilderX 打开项目即可运行到各端 ``` -### 安装与运行 +### 📱 运行到不同平台 -#### 1. 安装依赖 +使用 **HBuilderX** 打开项目后,可以一键运行到以下平台: -进入项目根目录,安装项目依赖: +
-```shell -# 推荐使用 pnpm(更快,更节省空间) -pnpm i +| 平台 | 运行方式 | 预览效果 | +| :---------------: | :--------------: | :----------: | +| 🌐 **Web** | 点击运行到浏览器 | 实时热重载 | +| 📱 **App** | 连接真机调试 | 原生性能体验 | +| 💬 **微信小程序** | 微信开发者工具 | 小程序预览 | +| 🦋 **鸿蒙** | HarmonyOS 模拟器 | 系统级集成 | -# 或者使用其他包管理器 -npm install -# yarn -``` +
-#### 2. 启动项目 +## 🛠️ 技术栈 -使用 [HBuilderX](https://www.dcloud.io/hbuilderx.html) 打开项目,即可运行到各个平台: +
-- **H5**:浏览器预览 -- **小程序**:微信、支付宝、百度等各大小程序平台 -- **App**:Android、iOS 原生应用 -- **鸿蒙**:华为鸿蒙 App([查看详细文档](https://uniapp.dcloud.net.cn/tutorial/harmony/runbuild.html)) +### 🏗️ 核心框架 + +![uni-app x](https://img.shields.io/badge/uni--app%20x-2CA5E0?style=for-the-badge&logo=vue.js&logoColor=white) +![Vue 3](https://img.shields.io/badge/Vue%203-4FC08D?style=for-the-badge&logo=vue.js&logoColor=white) +![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white) + +### 🎨 UI & 样式 + +![Tailwind CSS](https://img.shields.io/badge/Tailwind%20CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white) +![Cool UI](https://img.shields.io/badge/Cool%20UI-FF6B6B?style=for-the-badge&logo=componentstore&logoColor=white) + +### 🔧 开发工具 + +![Vite](https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge&logo=vite&logoColor=FFD62E) +![ESLint](https://img.shields.io/badge/ESLint-4B32C3?style=for-the-badge&logo=eslint&logoColor=white) +![Prettier](https://img.shields.io/badge/Prettier-F7B93E?style=for-the-badge&logo=prettier&logoColor=black) + +
+ +## 🤝 参与贡献 + +我们欢迎所有形式的贡献,无论是新功能、Bug 修复、文档改进还是其他任何改进。 + +### 💡 贡献方式 + +1. **🍴 Fork 项目** 到您的 GitHub 账户 +2. **🌿 创建特性分支** (`git checkout -b feature/AmazingFeature`) +3. **💾 提交更改** (`git commit -m 'Add some AmazingFeature'`) +4. **🚀 推送分支** (`git push origin feature/AmazingFeature`) +5. **🔄 创建 Pull Request** + +### 📋 开发规范 + +- 遵循现有的代码风格和架构设计 +- 为新功能添加相应的文档和示例 +- 确保所有测试通过 +- 提交信息请使用清晰的中英文描述 + +## 🌟 Star History + +
+ +[![Star History Chart](https://api.star-history.com/svg?repos=cool-team-official/cool-unix&type=Date)](https://star-history.com/#cool-team-official/cool-unix&Date) + +
+ +## 📞 技术支持 + +
+ +### 🤝 社区交流 + +[![QQ群](https://img.shields.io/badge/QQ群-1234567890-red?style=for-the-badge&logo=tencent-qq)](https://qm.qq.com/q/xxx) +[![微信群](https://img.shields.io/badge/微信群-Cool--Unix-green?style=for-the-badge&logo=wechat)](https://unix.cool-js.com/wechat) + +### 📊 问题反馈 + +[![GitHub Issues](https://img.shields.io/github/issues/cool-team-official/cool-unix?style=for-the-badge&logo=github)](https://github.com/cool-team-official/cool-unix/issues) +[![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-purple?style=for-the-badge&logo=github)](https://github.com/cool-team-official/cool-unix/discussions) + +
+ +## 📄 开源协议 + +本项目基于 [MIT 协议](LICENSE) 开源,您可以自由使用、修改和分发。 + +--- + +
+ +**🌟 如果这个项目对您有帮助,请给我们一个 Star!** + +**让我们一起构建更美好的跨端开发生态 🚀** + +_Made with ❤️ by [Cool Team](https://github.com/cool-team-official)_ + +