radiantone/eoc-backend

RadiantLogic CloudManager Backend 开发环境设置文档

概述

本文档详细介绍了RadiantLogic CloudManager Backend的开发环境搭建流程，包括依赖安装、容器化服务配置、认证集成、数据库管理等关键步骤，旨在帮助开发者快速搭建并配置后端服务的本地开发环境。

核心功能与特性

• 多依赖管理：支持nvm、Node.js、NestJS CLI等开发工具的安装与配置
• 容器化服务集成：提供Postgres、Redis、Grafana等必要服务的Docker容器部署方案
• 多平台OAuth认证：集成Google、Github、Microsoft Azure等第三方OAuth认证服务
• 数据库管理：包含数据库迁移、schema同步及用户创建等数据库操作指南
• 开发流程优化：提供Git钩子配置，确保代码提交规范

使用场景

适用于开发者在本地环境搭建RadiantLogic CloudManager Backend服务，进行功能开发、测试及调试工作。

开发环境的一次性设置

下载并安装nvm

访问https://github.com/coreybutler/nvm-windows%E4%B8%8B%E8%BD%BD%E5%B9%B6%E5%AE%89%E8%A3%85nvm%E3%80%82

安装Node.js（版本≥16）

bash
nvm install 16.18.0
nvm use 16.18.0

安装项目依赖

bash
npm install
npm install -g @nestjs/cli

配置开发环境

创建.env文件，以.env.sample为模板，根据以下步骤配置端口、数据库信息、凭据等参数。

运行Postgres Docker容器

bash
docker run -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=cloudmanager -p 5432:5432 --name "cloudmanager-postgres" -d postgres

镜像来源：https://hub.docker.com/_/postgres

运行Redis Docker容器

bash
docker run -p 6379:6379 --name "cloudmanager-redis" -d redis

镜像来源：https://hub.docker.com/_/redis

编辑hosts文件

在C:\Windows\System32\drivers\etc\hosts文件末尾添加：

127.0.0.1 radiantlogic-local.com

创建Google OAuth应用

1. 访问Google Cloud控制台
2. 导航至OAuth客户端创建页面

配置OAuth同意屏幕

!Google OAuth 同意屏幕 1 !Google OAuth 同意屏幕 3

创建Web应用类型的OAuth应用

!Google OAuth 应用

创建Github OAuth应用

1. 访问https://github.com/settings/developers
2. 导航至https://github.com/settings/applications/new

!Github OAuth 应用

注意：对于Google OAuth，电子邮件地址必须添加到OAuth同意屏幕配置的测试用户列表中。

Microsoft认证配置

注册Azure应用

1. 在Microsoft Azure门户注册新应用 !Microsoft Azure 应用注册

注意：应用需配置为多租户模式。

2. 获取客户端ID !Microsoft Azure 应用客户端ID

3. 创建客户端密钥 !Microsoft Azure 应用客户端密钥

安装Git钩子

bash
git config core.hooksPath .githooks

应用首次运行配置

创建管理员账户

在.env文件中设置管理员账户环境变量：

ADMIN_EMAIL=john.doe@example.com

更多配置选项参见.env.sample文件

运行应用

执行以下任一命令启动应用：

• npm run start（生产模式）
• npm run start:dev（开发模式，支持热重载）
• npm run start:debug（调试模式）

启动后，访问http://radiantlogic-local.com:3000/查看Swagger UI界面。

数据库Schema管理

自动同步

应用启动时会自动运行数据库迁移以更新schema。

手动执行迁移

bash
npm run typeorm:cli -- migration:run

迁移文档参考：TypeORM Migrations

开发环境Schema同步

开发过程中快速同步schema：

bash
npm run typeorm:cli -- schema:sync

参考：TypeORM FAQ

数据库用户创建

使用SQL客户端插入管理员用户，步骤如下：

1. 进入Postgres容器终端：

bash
docker exec -it cloudmanager-postgres bash

2. 连接数据库：

bash
psql -U postgres

3. 在psql shell中执行：

sql
\c cloudmanager;
INSERT INTO "user" ("email", "admin") VALUES ('your-email-here', true);

Grafana容器部署

Grafana是应用运行必需的监控组件，部署步骤如下：

1. 构建Grafana镜像：

bash
docker build -t grafana-eoc -f .\alertmanager\Grafana.dockerfile .\alertmanager\

2. 启动Grafana容器：

bash
docker run -d --name grafana -p 3008:3000 grafana-eoc

注意：可通过.env文件中的GRAFANA_URL配置项修改默认访问地址

数据库迁移创建

创建新的数据库迁移文件：

bash
npx typeorm-ts-node-commonjs migration:create /backend-workspace/src/migrations/addIsWhitelistActive