first commit

README.md

@@ -0,0 +1,83 @@
+# Go PMP
+
+本项目使用 [Ant Design Pro](https://pro.ant.design) 初始化。以下是使用指南。
+
+## 环境准备
+
+node 版本 >= v18.20.6
+
+pnpm 版本 >= 10.4.0
+
+安装 `node_modules`:
+
+```bash
+pnpm install
+```
+
+## 提供的脚本
+
+这些脚本在 `package.json` 中提供。可以修改或添加额外的脚本：
+
+### 启动项目（带 mock）
+
+```bash
+pnpm start
+```
+
+### 开发项目（不带 mock）
+
+```bash
+pnpm dev
+```
+
+### 构建项目
+
+```bash
+pnpm run build
+```
+
+### 检查代码风格
+
+```bash
+pnpm run lint
+```
+
+你也可以使用脚本自动修复一些 lint 错误：
+
+```bash
+pnpm run lint:fix
+```
+
+### 代码提交
+
+先在 `test` 分支开发，完成后可以使用 `commit.sh` 脚本提交代码
+
+```
+sh commit.sh -a -c 'feat: 添加了commit.sh脚本' -m
+```
+
+`-a` 表示提交所有修改的文件，`-c` 表示提交信息，`-m` 表示合并到 `master` 分支
+
+如果不想提交所有修改的文件，请先试用 `git add` 命令添加需要提交的文件，再使用 `commit.sh -c 'feat: 修改内容'` 提交即可
+
+## 参考文档
+
+[Ant Design Pro Document](https://pro.ant.design)
+
+[Ant Design Pro Github](https://github.com/ant-design/ant-design-pro).
+
+[ProComponents Document](https://procomponents.ant.design)
+
+[ProComponents Github](https://github.com/ant-design/pro-components)
+
+[Ant Design Document](https://ant.design/index-cn)
+
+[Ant Design Github](https://github.com/ant-design/ant-design)
+
+[Ant Design Icons](https://ant.design/components/icon-cn)
+
+[Icônes](https://icones.js.org/)
+
+[Umi Document](https://umijs.org/)
+
+[Umi Github](https://github.com/umijs/umi)