chatbi: A TypeScript repository from tearsofphoenix

ChatBI

中文 | English

ChatBI 是一个通过跟 AI 聊天来进行 BI 分析的系统。

原理分析参考文章：ChatGPT助力可视化方案探索

演示

准备

1. 注册 OpenAI 账号

2. 安装 Node.js 环境

参考：https://nodejs.org/en/learn/getting-started/how-to-install-nodejs

项目使用了 Node.js 中原生 fetch 方法，所以需要 Node.js >= 18，参考：https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#fetch

安装好 Node.js 之后，安装 pnpm：

npm install -g pnpm

3. 服务端配置

进入 server 目录，复制 .env.example 到 .env 并填写环境变量，如下：

# GPT 配置
OPENAI_API_BASE_URL=https://api.openai.com
OPENAI_API_KEY=xxx
OPENAI_MODEL=xxx

# MySQL
DB_CONNECTION=mysql://test:test@127.0.0.1:3306/test

3.1 服务端配置 - 阿里云灵积

如果你使用阿里云灵积，可以参考以下配置：

# GPT 配置
OPENAI_API_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode
OPENAI_API_KEY=sk-xxx
OPENAI_MODEL=qwen-max

# MySQL
DB_CONNECTION=mysql://test:test@127.0.0.1:3306/test

更多关于阿里云灵积的信息，参考：阿里云灵积

4. 安装依赖

在项目根目录执行：

pnpm install

5. 启动数据库 (可选)

为了本地开发演示，可以通过 docker 启动 MySQL：

cd ./docker && docker compose up -d

6. 运行

启动服务端：

$ pnpm run dev:server

启动客户端：

$ pnpm run dev:client

tearsofphoenix/chatbi