242 lines
8.4 KiB
Markdown
242 lines
8.4 KiB
Markdown
<div align="center">
|
||
|
||
# 🚀 Cool Unix
|
||
|
||
**基于 uni-app x 的现代化跨端应用开发脚手架**
|
||
|
||
_一次开发，全端运行 - 为您的创新想法提供最强大的技术底座_
|
||
|
||
[](https://github.com/cool-team-official/cool-unix/blob/master/LICENSE)
|
||
[](https://github.com/cool-team-official/cool-unix/releases)
|
||
[](https://github.com/cool-team-official/cool-unix/stargazers)
|
||
[](https://github.com/cool-team-official/cool-unix/network)
|
||
[](https://github.com/cool-team-official/cool-unix/commits)
|
||
|
||
<a href="https://unix.cool-js.com/" target="_blank">
|
||
<img src="https://unix.cool-js.com/logo.png" width="120" alt="Cool Unix Logo" />
|
||
</a>
|
||
|
||
[📖 在线文档](https://unix.cool-js.com/) · [🎯 快速开始](#-快速开始) · [✨ 特性展示](#-核心特性) · [🌟 在线预览](https://unix.cool-js.com/demo)
|
||
|
||
---
|
||
|
||
</div>
|
||
|
||
## 📋 目录
|
||
|
||
- [🌟 项目概述](#-项目概述)
|
||
- [🚀 平台兼容性](#-平台兼容性)
|
||
- [✨ 核心特性](#-核心特性)
|
||
- [🎯 快速开始](#-快速开始)
|
||
- [🛠️ 技术栈](#️-技术栈)
|
||
- [🤝 参与贡献](#-参与贡献)
|
||
- [📄 开源协议](#-开源协议)
|
||
|
||
## 🌟 项目概述
|
||
|
||
Cool Unix 是一个企业级的跨端应用开发脚手架，基于最新的 **uni-app x** 技术栈构建。它不仅仅是一个模板项目，更是一个完整的开发生态系统，为现代化应用开发提供了从架构设计到部署上线的全流程解决方案。
|
||
|
||
### 🎯 设计理念
|
||
|
||
- **🏗️ 架构优先**：基于现代化的分层架构设计，确保代码的可维护性和可扩展性
|
||
- **⚡ 性能驱动**：原生级别的运行性能，为用户提供流畅的使用体验
|
||
- **🔧 开发友好**：完善的开发工具链和丰富的组件库，大幅提升开发效率
|
||
- **🌐 生态完整**：一站式解决方案，涵盖认证、存储、UI、主题等各个方面
|
||
|
||
## 🚀 平台兼容性
|
||
|
||
<div align="center">
|
||
|
||
| 平台 | 支持状态 | 最低版本 | 特性支持 |
|
||
| :---------------: | :---------: | :------------: | :------------------: |
|
||
| 🍎 **iOS** | ✅ 完整支持 | iOS 9.0+ | 原生性能、推送、支付 |
|
||
| 🤖 **Android** | ✅ 完整支持 | Android 5.0+ | 原生性能、推送、支付 |
|
||
| 🦋 **鸿蒙 OS** | ✅ 完整支持 | HarmonyOS NEXT | 原生性能、系统集成 |
|
||
| 🌐 **Web** | ✅ 完整支持 | 现代浏览器 | PWA、响应式设计 |
|
||
| 💬 **微信小程序** | ✅ 完整支持 | 最新版本 | 微信生态集成 |
|
||
|
||
</div>
|
||
|
||
## ✨ 核心特性
|
||
|
||
### 🏗️ **企业级架构**
|
||
|
||
```
|
||
📁 分层架构设计，职责清晰
|
||
🔄 统一的状态管理
|
||
🎯 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 打开项目即可运行到各端
|
||
```
|
||
|
||
### 📱 运行到不同平台
|
||
|
||
使用 **HBuilderX** 打开项目后，可以一键运行到以下平台：
|
||
|
||
<div align="center">
|
||
|
||
| 平台 | 运行方式 | 预览效果 |
|
||
| :---------------: | :--------------: | :----------: |
|
||
| 🌐 **Web** | 点击运行到浏览器 | 实时热重载 |
|
||
| 📱 **App** | 连接真机调试 | 原生性能体验 |
|
||
| 💬 **微信小程序** | 微信开发者工具 | 小程序预览 |
|
||
| 🦋 **鸿蒙** | HarmonyOS 模拟器 | 系统级集成 |
|
||
|
||
</div>
|
||
|
||
## 🛠️ 技术栈
|
||
|
||
<div align="center">
|
||
|
||
### 🏗️ 核心框架
|
||
|
||
|
||
|
||
|
||
|
||
### 🎨 UI & 样式
|
||
|
||
|
||
|
||
|
||
### 🔧 开发工具
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
## 🤝 参与贡献
|
||
|
||
我们欢迎所有形式的贡献，无论是新功能、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
|
||
|
||
<div align="center">
|
||
|
||
[](https://star-history.com/#cool-team-official/cool-unix&Date)
|
||
|
||
</div>
|
||
|
||
## 📞 技术支持
|
||
|
||
<div align="center">
|
||
|
||
### 🤝 社区交流
|
||
|
||
[](https://qm.qq.com/q/xxx)
|
||
[](https://unix.cool-js.com/wechat)
|
||
|
||
### 📊 问题反馈
|
||
|
||
[](https://github.com/cool-team-official/cool-unix/issues)
|
||
[](https://github.com/cool-team-official/cool-unix/discussions)
|
||
|
||
</div>
|
||
|
||
## 📄 开源协议
|
||
|
||
本项目基于 [MIT 协议](LICENSE) 开源，您可以自由使用、修改和分发。
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
**🌟 如果这个项目对您有帮助，请给我们一个 Star！**
|
||
|
||
**让我们一起构建更美好的跨端开发生态 🚀**
|
||
|
||
_Made with ❤️ by [Cool Team](https://github.com/cool-team-official)_
|
||
|
||
</div>
|