diff --git a/README.md b/README.md index 1aca634..d266292 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,63 @@ # fes-starter A [fes.js](https://github.com/WeBankFinTech/fes.js) + TypeScript starter template. + +## Technology stack + +Basic: +- [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/) +- [JSX](https://v3.vuejs.org/guide/render-function.html#jsx) (optional, to replace Vue's template syntax) +- [SASS](https://sass-lang.com/) with [SCSS](https://sass-lang.com/documentation/syntax#scss) syntax for styling +- [ESLint](https://eslint.org/) with [@daotl/eslint-config-vue]() for linting +- [Prettier](https://prettier.io/) with [@daotl/prettier-config](https://github.com/daotl/web-style-configs#using-prettier-config) for code formatting +- [Stylelint](https://stylelint.io/) for linting CSS and SCSS + +`master` branch: +- [Element Plus](https://element-plus.org/): component library + +`antd` branch: +- [Ant Design Vue](https://www.antdv.com/): component library + +## Project setup +```shell +npm install +``` + +### Compiles and hot-reloads for development +```shell +fes dev +``` + +### Compiles and minifies for production +```shell +fes build +``` + +### Lint & fix +```shell +npm run lint +npm run lint:fix +``` + +See [Fes.js CLI docs](https://winixt.gitee.io/fesjs/zh/reference/cli/) for more. + +## Guides & References + +### Must-read + +Read the following must-read to understand the technology stack of this template. + +- [Fes.js Docs](https://winixt.gitee.io/fesjs/zh/guide/) +- [\