# SecondClassAPI

**Repository Path**: second-class/second-class-api

## Basic Information

- **Project Name**: SecondClassAPI
- **Description**: 第二课堂后端接口
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-01-03
- **Last Updated**: 2024-10-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# egg_secondclass



## QuickStart

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

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

### Development

```bash
$ mkdir egg_example && cd egg_example
$ npm init egg --type=simple
$ npm install || yarn install
$ npm run dev || yarn dev 
$ open http://localhost:7001/
```

### 安装sequelize插件

```bash
$ yarn add egg-sequelize mysql2
config.sequelize = {
  dialect: "mysql",
  host: "主机名",
  port: 端口,
  password: "密码",
  database: "数据库",
};

```

### 安装Swagger插件

```bash
$ yarn add egg-swagger-doc
https://www.npmjs.com/package/egg-swagger-doc?activeTab=readme
```

### 跨域处理

```bash
$ yarn add egg-cors
config.cors = {
  origin: "*",
  allowMethods: "GET,HEAD,PUT,POST,DELETE,PATCH",
};
```

### 密码加密处理

```bash
$ yarn add egg-bcrypt
config.bcrypt = {
  saltRounds: 10,
};

加密：ctx.genHash
```

### JWT token

```bash
$ yarn add egg-jwt
const token = ctx.app.jwt.sign({},this.app.config.jwt.secret,{ expiresIn: "30m" });
```

### 配置启动端口

```bash
config.cluster = {
  listen: {
    path: "",
    port: 9000,
    hostname: "127.0.0.1",
  },
};
```



### Deploy

```bash
$ npm start
$ npm stop
```

### 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