Commit 1f83f2724be8cbb4f555fd99e92e9d639f26325c
1 parent
876fe41c
Exists in
master
更新readme中文版
Showing
1 changed file
with
2 additions
and
36 deletions
Show diff stats
README.zh-CN.md
| 1 | # sf-erp-server | 1 | # sf-erp-server |
| 2 | 2 | ||
| 3 | +申服ERP的后端系统 | ||
| 3 | 4 | ||
| 4 | - | ||
| 5 | -## 快速入门 | ||
| 6 | - | ||
| 7 | -<!-- 在此次添加使用文档 --> | ||
| 8 | - | ||
| 9 | -如需进一步了解，参见 [egg 文档][egg]。 | ||
| 10 | - | ||
| 11 | -### 本地开发 | ||
| 12 | - | ||
| 13 | -```bash | ||
| 14 | -$ npm i | ||
| 15 | -$ npm run dev | ||
| 16 | -$ open http://localhost:7001/ | ||
| 17 | -``` | ||
| 18 | - | ||
| 19 | -### 部署 | ||
| 20 | - | ||
| 21 | -```bash | ||
| 22 | -$ npm start | ||
| 23 | -$ npm stop | ||
| 24 | -``` | ||
| 25 | - | ||
| 26 | -### 单元测试 | ||
| 27 | - | ||
| 28 | -- [egg-bin] 内置了 [mocha], [thunk-mocha], [power-assert], [istanbul] 等框架，让你可以专注于写单元测试，无需理会配套工具。 | ||
| 29 | -- 断言库非常推荐使用 [power-assert]。 | ||
| 30 | -- 具体参见 [egg 文档 - 单元测试](https://eggjs.org/zh-cn/core/unittest)。 | ||
| 31 | - | ||
| 32 | -### 内置指令 | ||
| 33 | - | ||
| 34 | -- 使用 `npm run lint` 来做代码风格检查。 | ||
| 35 | -- 使用 `npm test` 来执行单元测试。 | ||
| 36 | -- 使用 `npm run autod` 来自动检测依赖更新，详细参见 [autod](https://www.npmjs.com/package/autod) 。 | ||
| 37 | - | ||
| 38 | - | ||
| 39 | -[egg]: https://eggjs.org | 5 | +node.js egg.js |