diff --git a/README.md b/README.md index 0859a39..351b59c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,56 @@ -# cool-unix -uni-app x 项目脚手架Ï +# Cool Unix + +Cool Unix 是一个现代化的跨端应用开发脚手架,基于 uni-app x 技术栈,为开发者提供了完整的解决方案,助力快速构建高质量、高性能的跨平台应用。 + +- **Service 服务** - 统一的 API 请求管理 +- **uvue 组件库** - 原生级别的组件性能 +- **Tailwind CSS** - 实用优先的 CSS 框架 +- **多主题支持** - 自由切换主题色彩 +- **深色模式** - 适配用户偏好设置 +- **多语言切换** - 国际化应用必备 +- **图标自动导入** - 支持 Iconfont 和 Remixicon +- **微信小程序登录** - 无缝对接微信生态 +- **APP 微信登录** - 第三方授权登录 +- **一键登录** - 运营商快速登录 +- **短信验证码** - 传统可靠的登录方式 +- **本地存储** - 简单直接的文件管理 +- **七牛云** - 专业的对象存储服务 +- **阿里云 OSS** - 稳定可靠的存储方案 +- **腾讯云 COS** - 高性能存储服务 + +## 快速开始 + +### 开发环境推荐 + +- **代码编辑器**:[Cursor](https://cursor.com/cn) - AI 驱动的智能编辑器,提供强大的代码提示和生成功能 +- **运行调试工具**:[HBuilderX](https://www.dcloud.io/hbuilderx.html) - 专为 uni-app 优化的集成开发环境 + +### 获取项目代码 + +```shell +git clone https://github.com/cool-team-official/cool-unix.git +``` + +### 安装与运行 + +#### 1. 安装依赖 + +进入项目根目录,安装项目依赖: + +```shell +# 推荐使用 pnpm(更快,更节省空间) +pnpm i + +# 或者使用其他包管理器 +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))