# user-dashboard-backend

**Repository Path**: apulisplatform/user-dashboard-backend

## Basic Information

- **Project Name**: user-dashboard-backend
- **Description**: 用户权限管理组件服务端
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: v1.5.0
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-07-06
- **Last Updated**: 2022-09-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# 用户权限管理组件服务端

## 部署方式

### 1. 环境变量配置

在项目根目录下，需要有一个生成一个名称为 develop.env 的文件，里面记录了项目相关的配置信息
文件内容示例如下：

```

# Log
LOGGING_DIR=logs
LOGGING_LEVEL=debug

# Auth
JWT_SECRET_KEY=Sign key for JWT
SECRET_KEY=Sign key for Password

# OAuth
MS_CLIENT_ID=6d93837b-d8ce-48b9-868a-39a9d843dc57
MS_CLIENT_SECRET=eIHVKiG2TlYa387tssMSj?E?qVGvJi[]

WX_APP_ID=wx403e175ad2bf1d2d
WX_SECRET=dc8cb2946b1d8fe6256d49d63cd776d0

# Server
APP_HOST=localhost
APP_PORT=5001

# Database
DB_HOST=localhost
DB_TYPE=mysql
DB_PORT=3306
DB_USERNAME=root
DB_PASSWORD=123456
DB_NAME=user_group

ADMINISTRATOR_USER_NAME="["xianjie.han", "ADMIN"]"
ADMINISTRATOR_PASSWORD=123456
```

部分配置项说明：
JWT_SECRET_KEY： JWT 的签名 key
SECRET_KEY：加密用户密码的盐
ADMINISTRATOR_USER_NAME:  admin 权限的用户信息，是 Array 的格式


### 2. 编译

设置淘宝源

```
yarn config set registry 'https://registry.npm.taobao.org'
```

安装依赖

```
yarn
```

编译

```
yarn build
```



### 3. 运行项目命令

- 启动 redis
如果本地安装了 docker，可以运行
```
docker run -p9301:6379 redis
```
在 9301 端口运行 redis

- 启动 mysql：如果指定数据库类型为mysql的话
如果本地安装了 docker，可以运行
```
docker run --name mysql -e MYSQL_ROOT_PASSWORD=123456 -d -p 3306:3306  mysql:8.0
```
在 3306 端口运行 mysql

- 启动 pg：如果指定数据库类型为pg的话
如果本地安装了 docker，可以运行
```
docker run --name postgres -e POSTGRES_PASSWORD=123456 -d -p 5432:5432 postgres:10.12
```
在 5432 端口运行 postgres

- 启动项目
```
yarn start:prod
```

### 4. 初始化数据库 Table 和数据

项目使用的 typeorm 会自动初始化数据库