-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
63c2e77
commit b40e20e
Showing
2 changed files
with
45 additions
and
61 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,57 @@ | ||
# onepiece-admin | ||
# Ant Design Pro | ||
|
||
#### 介绍 | ||
onepiece-admin | ||
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 | ||
npm install | ||
``` | ||
|
||
1. xxxx | ||
2. xxxx | ||
3. xxxx | ||
or | ||
|
||
#### 使用说明 | ||
```bash | ||
yarn | ||
``` | ||
|
||
1. xxxx | ||
2. xxxx | ||
3. xxxx | ||
## Provided Scripts | ||
|
||
#### 参与贡献 | ||
Ant Design Pro provides some useful script to help you quick start and build with web project, code style check and test. | ||
|
||
1. Fork 本仓库 | ||
2. 新建 Feat_xxx 分支 | ||
3. 提交代码 | ||
4. 新建 Pull Request | ||
Scripts provided in `package.json`. It's safe to modify or add additional script: | ||
|
||
### Start project | ||
|
||
#### 特技 | ||
```bash | ||
npm start | ||
``` | ||
|
||
1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md | ||
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) | ||
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 | ||
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 | ||
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) | ||
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) | ||
### 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). |