# egg-template

**Repository Path**: node_org/egg-template

## Basic Information

- **Project Name**: egg-template
- **Description**: egg 模版
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-09-06
- **Last Updated**: 2023-07-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# egg-template

egg-template

## QuickStart

<!-- add docs here for user -->

see [egg docs][egg] for more detail.

### Development

```bash
$ npm i
$ npm run dev:local | dev:dev | dev:uat | dev:prod
$ open http://localhost:7001/
```

### Deploy

```bash
$ npm start:local | start:dev | start:uat | start:prod
$ npm stop:local | stop:dev | stop:uat | stop:prod
```

### 接口文档生成

```bash
$ npm run apidoc
$ open http://localhost:7001/apidoc/index.html
```

### 指定字段查询、排序

```js
await ctx.model.User.findAll({
	attributes: ['id', 'mobile', 'username', 'state', 'createTime', 'updateTime'],
	order: [['updateTime', 'DESC']],
});
```

### npm scripts

- Use `npm run lint` to check code style.
- Use `npm test` to run unit test.
- Use `npm run autod` to auto detect dependencies upgrade, see [autod](https://www.npmjs.com/package/autod) for more detail.

[egg]: https://eggjs.org