yite-cli
Version:
专注于vite + vue3 的项目开发脚手架
108 lines (71 loc) • 5.43 kB
Markdown
# yite-cli
`yite-cli` 是一个基于 `vite` 深度封装的 `vue3` 项目开发脚手架。
**提示**
本项目还处于开发状态，功能暂未稳定，请慎重使用。
### 仓库地址
[github - https://github.com/chenbimo/yite-cli](https://github.com/chenbimo/yite-cli)
### 作者介绍
[前端之虎陈随易 https://me.yicode.tech](https://me.yicode.tech)
### 文档教程
请到 [前端之虎陈随易 https://me.yicode.tech](https://me.yicode.tech) 网站查看。
### 设计思路
主要用于解决以下几个问题：
1. 直接使用 `vite`，每个项目都需要配置一次。
2. 项目的 `开发依赖` 不应该在项目中安装。
3. 不同的开发者导致的不够统一的使用方式。
所以，`yite-cli` 诞生了，并有效地解决了这些问题。
### 功能特性
- 不需要写路由配置，文件结构即路由。
- 默认提供 `i18n` 国际化多语言支持。
- 环境变量放到 `src/env` 目录中，便于管理。
- 默认提供自动导入文件、配置、组件、插件等。
- 灵活可控的项目骨架系统 (`layout`)。
- 默认提供封装好的全局 `pinia` 存储方案。
- 默认提供 `scss` 变量自动导入。
- 极少的项目依赖，所有开发依赖都在脚手架中。
- 一万多个图标开箱即用，按需导入，直接使用。
- 仅支持 `scss` 语法，避免选择，增强统一。
### 避免使用
- 对开发灵活性要求高的项目 (`yite-cli` 丢失部分灵活性，以求稳定性)。
- 需要动态路由的请不要使用，本项目使用权限验证方案。
- 目前只支持单页应用开发 (`ssg` 等方案未做验证)。
- 需要使用 `TypeScript` 的项目，本工具并没有集成与测试。
### 推荐使用
- 中小型，外包，个人项目。
- 需要减少开发时间，提高开发效率。
- 不想换人接手就大喊重构的项目。
### 赞赏支持
### 版权说明
`yite-cli` 使用 `Apache 2.0` 协议开源
> 一句话总结：开源不等于放弃版权，不可侵犯原作者版权，改动处要做说明，可以闭源使用。
拥有版权（Copyright）意味着你对你开发的软件及其源代码拥有著作权，所有权和其他法定权利，使用一个开源协议并不意味着放弃版权。
在 `Apache 2.0` 协议许可下，您可以：
- **商业化使用**（这意味着，您可以出于商业目的使用这些源代码）
- **再分发**（这意味着，您可以将源代码副本传输给其他任何人）
- **修改**（这意味着，您可以修改源代码）
- **专利使用**（这意味着，版权人明确声明授予您专利使用权）
- **私人使用**（这意味着，您可以出于一切目的私下使用和修改源代码）
唯须遵守以下条款：
- **协议和版权通知**（这意味着，软件中必须包含许可证和版权声明的副本）
- **状态更改说明**（如果您更改软件，您应当提供适当的说明）
除此之外，该软件：
- **提供责任限制**（版权人声明不对使用者造成的任何损失负责）
- **限制商标使用** (不能使用版权人的商标)
- **不提供任何担保**（版权人声明不为该软件的品质提供任何担保）
进一步说明：
1. 本软件又叫本 **作品**，可以是源码，也可以是编译或转换后的其他形式。**衍生作品** 是在本作品的基础上修改后的有原创性的工作成果。本作品的 **贡献者** 包括许可人和其他提交了贡献的人，以下统称 **我**。
2. 我授予你权利：你可以免费复制、使用、修改、再许可、分发本作品及衍生作品（可以不用公开源码）。
3. 如果本软件涉及我的专利（或潜在专利），我在此授予你专利许可，你可以永久性地免费使用此专利，用于制作、使用、出售、转让本作品。如果你哪天居然告本作品侵权，你的专利许可在你告我那天被收回。
4. 你在复制和分发本作品或衍生作品时，要满足以下条件。
- 带一份本许可证。
- 如果你修改了什么，要在改动的文件中有明显的修改声明。
- 如果你以源码形式分发，你必须保留本作品的版权、专利、商标和归属声明。
- 如果本作品带了 **NOTICE** 文件，你就得带上 **NOTICE** 文件中包含的归属声明。即便你的发布是不带源码的，你也得带上此文件，并在作品某处予以展示。
- 你可以对自己的修改添加版权说明。对于你的修改或者整个衍生作品，你可以使用不同的许可，但你对本作品的使用、复制和分发等，必须符合本许可证规定。
5. 你提交贡献就表明你默认遵守本许可的条款和条件。当然，你可以和我签订另外的专门的条款。
6. 你不许使用我的商品名、商标、服务标志或产品名。
7. 本作品是 **按原样**（AS IS）提供的，没有任何保证啊，你懂的。
8. 我可不负任何责任。除非我书面同意，或者法律有这样的要求（例如对故意和重大过失行为负责）。
9. 你可以向别人提供保证，你可以向别人收费，但那都是你的事，别给我惹麻烦。
注意以上的 **我**，既包含了许可人，也包含了每位 **贡献者**。