# chatbi

**Repository Path**: RexHuang936/chatbi

## Basic Information

- **Project Name**: chatbi
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2024-06-13
- **Last Updated**: 2024-11-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## ChatBI

中文 | [English](README.en.md)

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

原理分析参考文章：[ChatGPT助力可视化方案探索](https://zhuanlan.zhihu.com/p/631013261)

## 演示

![ava](./demos/ava.png)
![vega](./demos/vega.png)

## 准备

### 1. 注册 OpenAI 账号

注册 [OpenAI](https://openai.com/) 账号，获取 API Key

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

```bash
npm install -g pnpm
```

### 3. 服务端配置


进入 `server` 目录，复制 `.env.example` 到 `.env` 并填写环境变量，如下：
  
```bash
# Database
OPENAI_API_BASE_URL=https://api.openai.com
OPENAI_API_KEY=xxx

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

安装服务端依赖：

```bash
pnpm install
```

### 4. 安装依赖

在项目根目录执行：
  
```bash
pnpm install
```

### 5. 启动数据库 (可选)

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

```bash
cd ./server/docker && docker-compose up -d
```

### 6. 运行

1. 启动服务端：

```bash
$ pnpm run dev:server
```

2. 启动客户端：

```bash
$ pnpm run dev:client
```