Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jsxiaosi/nuxt3-template

Nuxt3+Ts模板
https://github.com/jsxiaosi/nuxt3-template

Last synced: 12 days ago
JSON representation

Nuxt3+Ts模板

Awesome Lists containing this project

README

        

# Nuxt3 Template

- 简洁开封即用
- 内置常用工具,`VueUse`,`I18n`,`Pinia`
- 合理的规范配置`ESlint`,`Prettier`,`CommitLint`

## 安装使用

- 获取项目代码(https or ssh)

```bash
git clone https://github.com/jsxiaosi/nuxt3-template.git

git clone [email protected]:jsxiaosi/nuxt3-template.git
```

或者通过[`xs-cli`](https://github.com/jsxiaosi/xs-cli)快速创建

```bash
npx @jsxiaosi/xs-cli create [project-name]
```

- 安装依赖

```bash
cd vite-vue3-Template

npm install

# 建议不要直接使用 cnpm 安装以来,会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
# 如果下载依赖慢可以使用淘宝镜像源安装依赖
npm install --registry=https://registry.npm.taobao.org

```

- 运行

```bash
npm run dev
```

- 打包

```bash
npm run build
```

## 如何贡献

**Pull Request:**

1. Fork 代码!
2. 创建自己的分支: `git checkout -b feature/xxxx`
3. 提交你的修改: `git commit -m 'feature: add xxxxx'`
4. 推送您的分支: `git push origin feature/xxxx`
5. 提交`pull request`

## Git 贡献提交规范

- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范

- `feat` 新增功能
- `fix` 修复缺陷
- `docs` 文档变更
- `style` 代码格式
- `refactor` 代码重构
- `perf` 性能优化
- `test` 添加疏漏测试或已有测试改动
- `build` 构建流程、外部依赖变更 (如升级 npm 包、修改打包配置等)
- `ci` 修改 CI 配置、脚本
- `revert` 回滚 commit
- `chore` 对构建过程或辅助工具和库的更改 (不影响源文件)
- `wip` 正在开发中
- `types` 类型定义文件修改

## 维护者

[@jsxiaosi](https://github.com/jsxiaosi)

## License

[MIT © 2022](./LICENSE)