mirror of
https://github.com/Tencent/tdesign-vue-next-starter.git
synced 2024-11-10 07:48:22 +08:00
docs: README in English (#301)
* fix: miss layout header * docs: readme in english * fix: typo and grammar (#300) * chore: add lang tab Co-authored-by: Thet Paing Hein <paiakarit@gmail.com>
This commit is contained in:
yuyang
GitHub
parent
4a5cdaf51b
commit
7e40754fc1
97
README-en_US.md
Normal file
97
README-en_US.md
Normal file
|
|
@ -0,0 +1,97 @@
|
||||||
|
<p style="display:flex; justify-content: center">
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://tdesign.tencent.com/starter/vue-next/#/dashboard/base" target="_blank">
|
||||||
|
<img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/starter/brand-logo.svg">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatility"></a>
|
||||||
|
<a href="https://github.com/Tencent/tdesign-vue-next/blob/develop/LICENSE">
|
||||||
|
<img src="https://img.shields.io/npm/l/tdesign-vue-next.svg?sanitize=true" alt="License">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
### Introduction
|
||||||
|
|
||||||
|
TDesign Vue Next Starter is a TDesign-based developed with `Vue3`, `Vite2`, `Pinia`, `TypeScript`. It can be customized theme configuration, and aims to provide project out-of-the-box, configuration-style middle and background projects.
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a href="http://tdesign.tencent.com/starter/vue-next/">Live Preview</a>
|
||||||
|
·
|
||||||
|
<a href="https://tdesign.tencent.com/starter/">Documentation</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<img src="docs/starter.png">
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Various provided pages for develop
|
||||||
|
- Complete directory structure for develop
|
||||||
|
- Code specification configuration
|
||||||
|
- Support dark mode
|
||||||
|
- Custom theme colors
|
||||||
|
- Various space layouts
|
||||||
|
- Mock data scheme
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
> Initialize project with our CLI tool `tdesign-starter-cli`
|
||||||
|
|
||||||
|
```bash
|
||||||
|
## install tdesign-starter-cli
|
||||||
|
npm i tdesign-starter-cli@latest -g
|
||||||
|
|
||||||
|
## create project
|
||||||
|
td-starter init
|
||||||
|
```
|
||||||
|
|
||||||
|
### Develop
|
||||||
|
|
||||||
|
```bash
|
||||||
|
## install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
## set up
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
### Build
|
||||||
|
|
||||||
|
```bash
|
||||||
|
## build
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
## build for test
|
||||||
|
npm run build:test
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Contributing Guide
|
||||||
|
|
||||||
|
We welcome contributions to our project. Create your [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls).
|
||||||
|
|
||||||
|
#### Pull Request
|
||||||
|
|
||||||
|
1. Fork it!
|
||||||
|
2. Create your branch: `git checkout -b feat/xxxx`
|
||||||
|
3. Commit: `git commit -a 'feat(project): describe'`
|
||||||
|
4. Push: `git push origin feat/xxxx`
|
||||||
|
5. New Pull Request `pull request`
|
||||||
|
|
||||||
|
#### Commit Specification
|
||||||
|
|
||||||
|
- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
|
||||||
|
- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories)
|
||||||
|
|
||||||
|
### Compatibility
|
||||||
|
|
||||||
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br> IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
|
||||||
|
|
||||||
|
### License
|
||||||
|
|
||||||
|
The MIT License. Please see [the license file](LICENSE) for more information.
|
||||||
120
README-zh_CN.md
Normal file
120
README-zh_CN.md
Normal file
|
|
@ -0,0 +1,120 @@
|
||||||
|
|
||||||
|
<p style="display:flex; justify-content: center">
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://tdesign.tencent.com/starter/vue-next/#/dashboard/base" target="_blank">
|
||||||
|
<img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/starter/brand-logo.svg">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatility"></a>
|
||||||
|
<a href="https://github.com/Tencent/tdesign-vue-next/blob/develop/LICENSE">
|
||||||
|
<img src="https://img.shields.io/npm/l/tdesign-vue-next.svg?sanitize=true" alt="License">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
简体中文 | [English](./README.md)
|
||||||
|
|
||||||
|
### 项目简介
|
||||||
|
|
||||||
|
TDesign Vue Next Starter 是一个基于 TDesign，使用 `Vue3`、`Vite2`、`Pinia`、`TypeScript` 开发，可进行个性化主题配置，旨在提供项目开箱即用的、配置式的中后台项目。
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a href="http://tdesign.tencent.com/starter/vue-next/">在线预览</a>
|
||||||
|
·
|
||||||
|
<a href="https://tdesign.tencent.com/starter/">使用文档</a>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<img src="docs/starter.png">
|
||||||
|
|
||||||
|
### 特性
|
||||||
|
|
||||||
|
- 内置多种常用的中后台页面
|
||||||
|
- 完善的目录结构
|
||||||
|
- 完善的代码规范配置
|
||||||
|
- 支持暗黑模式
|
||||||
|
- 自定义主题颜色
|
||||||
|
- 多种空间布局
|
||||||
|
- 内置 Mock 数据方案
|
||||||
|
|
||||||
|
### 使用
|
||||||
|
|
||||||
|
> 通过 `tdesign-starter-cli` 初始化项目仓库
|
||||||
|
|
||||||
|
```bash
|
||||||
|
## 1、安装 tdesign-starter-cli
|
||||||
|
npm i tdesign-starter-cli@latest -g
|
||||||
|
|
||||||
|
## 2、创建项目
|
||||||
|
td-starter init
|
||||||
|
```
|
||||||
|
|
||||||
|
### 开发
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
## 安装依赖
|
||||||
|
npm install
|
||||||
|
|
||||||
|
## 启动项目
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
### 构建
|
||||||
|
|
||||||
|
```bash
|
||||||
|
## 构建正式环境
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
## 构建测试环境
|
||||||
|
npm run build:test
|
||||||
|
```
|
||||||
|
|
||||||
|
### 其他
|
||||||
|
|
||||||
|
```bash
|
||||||
|
## 预览构建产物
|
||||||
|
npm run preview
|
||||||
|
|
||||||
|
## 代码格式检查
|
||||||
|
npm run lint
|
||||||
|
|
||||||
|
## 代码格式检查与自动修复
|
||||||
|
npm run lint:fix
|
||||||
|
|
||||||
|
## style格式检查
|
||||||
|
npm run stylelint
|
||||||
|
|
||||||
|
## style格式检查与自动修复
|
||||||
|
npm run stylelint:fix
|
||||||
|
```
|
||||||
|
|
||||||
|
### 如何贡献
|
||||||
|
|
||||||
|
非常欢迎您的贡献！提交您的 [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) 或者提交 [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls)。
|
||||||
|
|
||||||
|
#### Pull Request
|
||||||
|
|
||||||
|
1. Fork 代码!
|
||||||
|
2. 创建自己的分支: `git checkout -b feat/xxxx`
|
||||||
|
3. 提交你的修改: `git commit -a 'feat(project): describe'`
|
||||||
|
4. 推送您的分支: `git push origin feat/xxxx`
|
||||||
|
5. 提交 `pull request`
|
||||||
|
|
||||||
|
#### 贡献提交规范
|
||||||
|
|
||||||
|
- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
|
||||||
|
- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories)
|
||||||
|
|
||||||
|
### 兼容性
|
||||||
|
|
||||||
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br> IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
|
||||||
|
|
||||||
|
### 开源协议
|
||||||
|
|
||||||
|
TDesign 遵循 [MIT 协议](https://github.com/Tencent/tdesign-vue-next-starter/LICENSE)。
|
||||||
|
|
||||||
91
README.md
91
README.md
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
<p style="display:flex; justify-content: center">
|
<p style="display:flex; justify-content: center">
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
@ -15,104 +14,86 @@
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### 项目简介
|
English | [简体中文](./README-zh_CN.md)
|
||||||
|
### Introduction
|
||||||
|
|
||||||
TDesign Vue Next Starter 是一个基于 TDesign，使用 `Vue3`、`Vite2`、`Pinia`、`TypeScript` 开发，可进行个性化主题配置，旨在提供项目开箱即用的、配置式的中后台项目。
|
TDesign Vue Next Starter is a TDesign-based, developed with `Vue3`, `Vite2`, `Pinia`, `TypeScript`, which can be customized theme configuration, and aims to provide project out-of-the-box, configuration-style middle and background projects .
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<a href="http://tdesign.tencent.com/starter/vue-next/">在线预览</a>
|
<a href="http://tdesign.tencent.com/starter/vue-next/">preview</a>
|
||||||
·
|
·
|
||||||
<a href="https://tdesign.tencent.com/starter/">使用文档</a>
|
<a href="https://tdesign.tencent.com/starter/">documentation</a>
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<img src="docs/starter.png">
|
<img src="docs/starter.png">
|
||||||
|
|
||||||
### 特性
|
### Features
|
||||||
|
|
||||||
- 内置多种常用的中后台页面
|
- Various provided pages for develop
|
||||||
- 完善的目录结构
|
- Complete Directory Structure for develop
|
||||||
- 完善的代码规范配置
|
- Code Specification Configuration
|
||||||
- 支持暗黑模式
|
- Dark Mode
|
||||||
- 自定义主题颜色
|
- Custom theme colors
|
||||||
- 多种空间布局
|
- Various space layouts
|
||||||
- 内置 Mock 数据方案
|
- Mock Data Scheme
|
||||||
|
|
||||||
### 使用
|
### Usage
|
||||||
|
|
||||||
> 通过 `tdesign-starter-cli` 初始化项目仓库
|
> init project with our CLI tool `tdesign-starter-cli`
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
## 1、安装 tdesign-starter-cli
|
## install tdesign-starter-cli
|
||||||
npm i tdesign-starter-cli@latest -g
|
npm i tdesign-starter-cli@latest -g
|
||||||
|
|
||||||
## 2、创建项目
|
## 2、create project
|
||||||
td-starter init
|
td-starter init
|
||||||
```
|
```
|
||||||
|
|
||||||
### 开发
|
### Develop
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
## 安装依赖
|
## install dependencies
|
||||||
npm install
|
npm install
|
||||||
|
|
||||||
## 启动项目
|
## set up
|
||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### 构建
|
### Build
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
## 构建正式环境
|
## build
|
||||||
npm run build
|
npm run build
|
||||||
|
|
||||||
## 构建测试环境
|
## build for test
|
||||||
npm run build:test
|
npm run build:test
|
||||||
```
|
```
|
||||||
|
|
||||||
### 其他
|
|
||||||
|
|
||||||
```bash
|
### Contributing
|
||||||
## 预览构建产物
|
|
||||||
npm run preview
|
|
||||||
|
|
||||||
## 代码格式检查
|
Contributing is welcome！Create your [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls)。
|
||||||
npm run lint
|
|
||||||
|
|
||||||
## 代码格式检查与自动修复
|
|
||||||
npm run lint:fix
|
|
||||||
|
|
||||||
## style格式检查
|
|
||||||
npm run stylelint
|
|
||||||
|
|
||||||
## style格式检查与自动修复
|
|
||||||
npm run stylelint:fix
|
|
||||||
```
|
|
||||||
|
|
||||||
### 如何贡献
|
|
||||||
|
|
||||||
非常欢迎您的贡献！提交您的 [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) 或者提交 [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls)。
|
|
||||||
|
|
||||||
#### Pull Request
|
#### Pull Request
|
||||||
|
|
||||||
1. Fork 代码!
|
1. Fork it!
|
||||||
2. 创建自己的分支: `git checkout -b feat/xxxx`
|
2. Create your branch: `git checkout -b feat/xxxx`
|
||||||
3. 提交你的修改: `git commit -a 'feat(project): describe'`
|
3. Commit: `git commit -a 'feat(project): describe'`
|
||||||
4. 推送您的分支: `git push origin feat/xxxx`
|
4. Push: `git push origin feat/xxxx`
|
||||||
5. 提交 `pull request`
|
5. New Pull Request `pull request`
|
||||||
|
|
||||||
#### 贡献提交规范
|
#### Commit Specification
|
||||||
|
|
||||||
- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
|
- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
|
||||||
- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories)
|
- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories)
|
||||||
|
|
||||||
### 兼容性
|
### Compatibility
|
||||||
|
|
||||||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br> IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br> IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
|
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
|
||||||
|
|
||||||
### 开源协议
|
### LICENSE
|
||||||
|
|
||||||
TDesign 遵循 [MIT 协议](https://github.com/Tencent/tdesign-vue-next-starter/LICENSE)。
|
|
||||||
|
|
||||||
|
[MIT](https://github.com/Tencent/tdesign-vue-next-starter/LICENSE)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user