Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
WittBulter committed May 15, 2019
1 parent 42dadb2 commit 41671be
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ the best practice of building Koa2 with TypeScript. [中文](/README_CN.md)

2. Install dependencies: `yarn` or `npm i`.

3. **[Optional]** if you need database, set *useMongoDB* to true.(in `configs/customs.ts`).
3. Lift srever: `yarn start` or `npm start`. visit: http://127.0.0.1:3000/apis/sessions

4. **[Optional]** the project has built-in a docker-compose, run `npm run mongo` lift mongodb automatic.
  **[Optional]** if you need database, set *useMongoDB* to true.(in `configs/customs.ts`).

  **[Optional]** the project has built-in a docker-compose, run `npm run mongo` lift mongodb automatic.
<br>

### Catalog
Expand Down
6 changes: 4 additions & 2 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@

2. 安装依赖: `yarn``npm i`

3. **[可选]** 如果你需要数据库,请设置 `useMongoDB = true` (在 `configs/customs.ts` 文件中)
3. 挂起服务:`yarn start``npm start`,访问 http://127.0.0.1:3000/apis/sessions 示例

4. **[可选]** 项目内置了 docker-compose 数据库,可以使用 `npm run mongo` 自动挂起 mongo (如果您已有 docker / docker-compose)。
&nbsp;&nbsp;**[可选]** 如果你需要数据库,请设置 `useMongoDB = true` (在 `configs/customs.ts` 文件中)。

&nbsp;&nbsp;**[可选]** 项目内置了 docker-compose 数据库,可以使用 `npm run mongo` 自动挂起 mongo (如果您已有 docker / docker-compose)。

<br>

Expand Down

0 comments on commit 41671be

Please sign in to comment.