docs: update README

This commit is contained in:
Nex Zhu 2021-12-27 17:31:15 +08:00
parent 36ff5aff2b
commit d848c6934c
No known key found for this signature in database
GPG Key ID: 15C6254AD19362B4

View File

@ -5,6 +5,7 @@ A [fes.js](https://github.com/WeBankFinTech/fes.js) + TypeScript starter templat
## Technology stack ## Technology stack
Basic: Basic:
- [TypeScript](https://www.typescriptlang.org/) - [TypeScript](https://www.typescriptlang.org/)
- [fes.js](https://github.com/WeBankFinTech/fes.js) based on [Vue 3](https://v3.vuejs.org/) and [Webpack](https://webpack.js.org/) - [fes.js](https://github.com/WeBankFinTech/fes.js) based on [Vue 3](https://v3.vuejs.org/) and [Webpack](https://webpack.js.org/)
- [JSX](https://v3.vuejs.org/guide/render-function.html#jsx) (optional, to replace Vue's template syntax) - [JSX](https://v3.vuejs.org/guide/render-function.html#jsx) (optional, to replace Vue's template syntax)
@ -14,33 +15,40 @@ Basic:
- [Stylelint](https://stylelint.io/) for linting CSS and SCSS - [Stylelint](https://stylelint.io/) for linting CSS and SCSS
`master` branch: `master` branch:
- [Element Plus](https://element-plus.org/): component library - [Element Plus](https://element-plus.org/): component library
`antd` branch: `antd` branch:
- [Ant Design Vue](https://www.antdv.com/): component library - [Ant Design Vue](https://www.antdv.com/): component library
## Project setup ## Project setup
```shell ```shell
npm install -g @fesjs/create-fes-app
npm install npm install
``` ```
### Compiles and hot-reloads for development ### Compiles and hot-reloads for development
```shell ```shell
fes dev npm run dev
``` ```
### Compiles and minifies for production ### Compiles and minifies for production
```shell ```shell
fes build npm run prod
``` ```
### Lint & fix ### Lint & fix
```shell ```shell
npm run lint npm run lint
npm run lint:fix npm run lint:fix
``` ```
See [Fes.js CLI docs](https://winixt.gitee.io/fesjs/zh/reference/cli/) for more. See [Fes.js CLI docs](https://winixt.gitee.io/fesjs/zh/reference/cli/) and [package.json](./package.json) for more.
## Guides & References ## Guides & References