frontend-template/README.md

69 lines
1.4 KiB
Markdown

# Ant Design Pro
This project is initialized with [Ant Design Pro](https://pro.ant.design). Follow is the quick guide for how to use.
## Environment Prepare
Install `node_modules`:
```bash
yarn install
```
or
```bash
yarn
```
## Provided Scripts
Ant Design Pro provides some useful script to help you quick start and build with web project, code style check and test.
Scripts provided in `package.json`. It's safe to modify or add additional script:
### Start project
```bash
npm start
```
### Build project
```bash
npm run build
```
### Check code style
```bash
npm run lint
```
You can also use script to auto fix some lint error:
```bash
npm run lint:fix
```
### Test code
```bash
npm test
```
## More
You can view full document on our [official website](https://pro.ant.design). And welcome any feedback in our [github](https://github.com/ant-design/ant-design-pro).
### 参考文档
1. [ts 入门](https://ts.xcatliu.com/)
1. [react hook 入门](https://www.ruanyifeng.com/blog/2019/09/react-hooks.html)
1. [antd4.0](https://ant-design.gitee.io/components/overview-cn/)
1. [@ant-design/pro-layout](https://procomponents.ant.design/components/layout)
1. [@ant-design/icons](https://ant.design/components/icon-cn/#API)
1. [@ant-design/pro-table](https://procomponents.ant.design/components/table)
1. [@formily/antd-components](https://formilyjs.org/#/zoi8i0/ZrsYs6hytQ)
1. [@formily](https://formilyjs.org)