更新文档
This commit is contained in:
icssoa
215
README.md
215
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
# 🚀 Cool Unix
|
||||
|
||||
**基于 uni-app x 的现代化跨端应用开发脚手架**
|
||||
**基于 uni-app x 的跨端应用开发脚手架**
|
||||
|
||||
_一次开发，全端运行 - 为您的创新想法提供最强大的技术底座_
|
||||
|
||||
@@ -12,89 +12,117 @@ _一次开发，全端运行 - 为您的创新想法提供最强大的技术底
|
||||
[](https://github.com/cool-team-official/cool-unix/network)
|
||||
[](https://github.com/cool-team-official/cool-unix/commits)
|
||||
|
||||
[📖 在线文档](https://unix.cool-js.com/) · [🎯 快速开始](https://unix.cool-js.com/src/introduce/quick.html) · [🌟 在线预览](https://unix.cool-js.com/demo)
|
||||
|
||||
</div>
|
||||
|
||||
## 🌟 项目概述
|
||||
### 项目概述
|
||||
|
||||
Cool Unix 是一个企业级的跨端应用开发脚手架，基于最新的 **uni-app x** 技术栈构建。它不仅仅是一个模板项目，更是一个完整的开发生态系统，为现代化应用开发提供了从架构设计到部署上线的全流程解决方案。
|
||||
Cool Unix 是一个高效的项目脚手架。它内置了 UI 组件库、Service 请求、TailwindCSS 插件、多语言一键翻译等多种实用功能，极大提升了开发者的开发效率与体验。
|
||||
|
||||
## 🚀 平台兼容性
|
||||
- [📖 在线文档](https://unix.cool-js.com/)
|
||||
|
||||
- [🎯 快速开始](https://unix.cool-js.com/src/introduce/quick.html)
|
||||
|
||||
- [🌟 在线预览](https://unix.cool-js.com/demo)
|
||||
|
||||
### 组件库引入
|
||||
|
||||
如果你只需使用组件库，请参考 [🚀 组件库引入指南](https://unix.cool-js.com/src/introduce/uni-components.html) 进行配置，快速集成到你的项目中。
|
||||
|
||||
### 多语言
|
||||
|
||||
配置完成后，仅需执行一条命令，AI 即可自动检索并统一翻译全文内容，无需手动维护繁琐的中英对照表，大幅提升多语言开发效率。
|
||||
|
||||
```html
|
||||
<text>{{ t('你好') }}</text>
|
||||
```
|
||||
|
||||
在其他位置上绑定如下：
|
||||
|
||||
```html
|
||||
<script setup lang="ts">
|
||||
import { $t, t } from "@/uni_modules/cool-unix";
|
||||
import { useUi } from "@/uni_modules/cool-unix";
|
||||
|
||||
const ui = useUi();
|
||||
|
||||
ui.showToast({
|
||||
message: t("操作成功")
|
||||
});
|
||||
|
||||
ui.showToast({
|
||||
message: $t("欢迎回来，{name}", { name: "神仙都没用" })
|
||||
});
|
||||
</script>
|
||||
```
|
||||
|
||||
```shell
|
||||
npx cool-i18n create
|
||||
```
|
||||
|
||||
### TailwindCSS
|
||||
|
||||
不同于其他 UI 组件库仅内置简单样式，Cool Unix 深度兼容 TailwindCSS 的写法，支持如 `dark:`、`!` 等操作符，既保留了灵活性，也便于扩展。
|
||||
|
||||
```html
|
||||
<view class="bg-surface-100 dark:!bg-surface-900">
|
||||
<text class="text-surface-700 dark:!text-white">Cool Unix</text>
|
||||
</view>
|
||||
```
|
||||
|
||||
### PassThrough
|
||||
|
||||
PassThrough 是一种用于访问组件内部 DOM 结构的 API，它允许开发者将任意属性和监听器直接应用于组件内部的 DOM 元素。这种设计的核心优势在于突破了组件主要 API 的限制，提供更灵活的定制能力。
|
||||
|
||||
```html
|
||||
<cl-button
|
||||
:pt="{
|
||||
className: '!rounded-2xl',
|
||||
icon: {
|
||||
size: 50,
|
||||
className: 'mr-5',
|
||||
},
|
||||
label: {
|
||||
color: 'red',
|
||||
className: 'font-bold',
|
||||
},
|
||||
loading: {
|
||||
size: 50,
|
||||
},
|
||||
}"
|
||||
>
|
||||
点击
|
||||
</cl-button>
|
||||
```
|
||||
|
||||
### 预览
|
||||
|
||||
<div style="display: flex; align-items: center; gap: 40px;">
|
||||
<div style="text-align: center;">
|
||||
<img src="https://unix.cool-js.com/qrcode-h5.png" width="200px" />
|
||||
<p>H5 预览</p>
|
||||
</div>
|
||||
<div style="text-align: center;">
|
||||
<img src="https://unix.cool-js.com/qrcode-apk.png" width="200px" />
|
||||
<p>APP 下载</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
### 技术栈
|
||||
|
||||
<div align="center">
|
||||
|
||||
| 平台 | 支持状态 | 最低版本 | 特性支持 |
|
||||
| :---------------: | :---------: | :------------: | :------------------: |
|
||||
| 🍎 **iOS** | ✅ 完整支持 | iOS 9.0+ | 原生性能、推送、支付 |
|
||||
| 🤖 **Android** | ✅ 完整支持 | Android 5.0+ | 原生性能、推送、支付 |
|
||||
| 🦋 **鸿蒙 OS** | ✅ 完整支持 | HarmonyOS NEXT | 原生性能、系统集成 |
|
||||
| 🌐 **Web** | ✅ 完整支持 | 现代浏览器 | PWA、响应式设计 |
|
||||
| 💬 **微信小程序** | ✅ 完整支持 | 最新版本 | 微信生态集成 |
|
||||
|
||||
</div>
|
||||
|
||||
### ⚡ **极致性能**
|
||||
|
||||
```
|
||||
🎯 Service层API封装
|
||||
🚀 uni-app x 原生渲染
|
||||
📱 接近原生应用性能
|
||||
⚙️ 智能编译优化
|
||||
```
|
||||
|
||||
### 🎨 **视觉体验**
|
||||
|
||||
```
|
||||
🌈 Tailwind CSS 工具类
|
||||
🎯 Cool Ui 组件库
|
||||
🌙 深色模式支持
|
||||
🎨 多主题动态切换
|
||||
```
|
||||
|
||||
### 🔐 **认证体系**
|
||||
|
||||
```
|
||||
📱 微信小程序一键登录
|
||||
🔑 APP 微信授权登录
|
||||
📞 运营商一键登录
|
||||
📩 短信验证码登录
|
||||
```
|
||||
|
||||
### ☁️ **云服务集成**
|
||||
|
||||
```
|
||||
📁 本地文件存储
|
||||
🗂️ 七牛云对象存储
|
||||
☁️ 阿里云 OSS
|
||||
🌥️ 腾讯云 COS
|
||||
🔄 多云存储切换
|
||||
```
|
||||
|
||||
### 🎛️ **开发工具**
|
||||
|
||||
```
|
||||
🎯 图标自动导入（Iconfont + Remixicon）
|
||||
🔍 智能代码提示
|
||||
🔄 多语言AI自动翻译
|
||||
```
|
||||
|
||||
## 🛠️ 技术栈
|
||||
|
||||
<div align="center">
|
||||
|
||||
### 🏗️ 核心框架
|
||||
### 核心框架
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 🎨 UI & 样式
|
||||
### UI & 样式
|
||||
|
||||
|
||||
|
||||
|
||||
### 🔧 开发工具
|
||||
### 开发工具
|
||||
|
||||
|
||||
|
||||
@@ -102,26 +130,7 @@ Cool Unix 是一个企业级的跨端应用开发脚手架，基于最新的 **u
|
||||
|
||||
</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
|
||||
### Star History
|
||||
|
||||
<div align="center">
|
||||
|
||||
@@ -129,34 +138,10 @@ Cool Unix 是一个企业级的跨端应用开发脚手架，基于最新的 **u
|
||||
|
||||
</div>
|
||||
|
||||
## 📞 技术支持
|
||||
### 参与贡献
|
||||
|
||||
<div align="center">
|
||||
我们欢迎所有形式的贡献，无论是新功能、Bug 修复、文档改进还是其他任何改进。
|
||||
|
||||
### 🤝 社区交流
|
||||
|
||||
[](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>
|
||||
|
||||
Reference in New Issue
Block a user