# trello-backend

**Repository Path**: allenthinking/trello-backend

## Basic Information

- **Project Name**: trello-backend
- **Description**: 配合trello-vue的服务器
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2022-03-16
- **Last Updated**: 2022-03-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### trello-backend 使用步骤

#### 步骤1

> 安装 `mysql`
> 修改 `src/configs/database.json` 中的配置,改成你自己数据库的名字，密码以及数据库的名字
```json
{
  "username": "root",
  "password": "123456",
  "database": "trello_dev"
}
```

#### 步骤2

> 查看 `package.json` 中的命令
> 在终端输入 `yarn db:init` 等命令完成后，刷新数据库即可看到数据

#### 步骤3

> 在终端输入 `yarn install`
> 在终端输入 `yarn dev` 启动服务器，确保服务器运行在 `localhost:8080`


### trello-backend 的说明

> 路由功能方面主要是由 `koa-ts-controller` 负责
> 接口功能的代码主要在 `src/controller` 文件夹下
> 验证前端传递过来的参数由 `src/validators` 文件夹下的对应文件负责
> 前端传过来的附件主要保存在 `src/attachments` 下
> 数据库方面的设置, `src/database/migrations` 定义了表的结构， `src/database/seeders` 初始化了表中的数据