Commit fe830538 authored by jaden's avatar jaden

fix: update readme

parent 9cb4443b
......@@ -7,17 +7,16 @@
## 演示
> [view](https://chat-query.vercel.app/)
> [在线预览](https://query.fusiontech.cn/)
> [国内](http://139.198.179.193:30648/)
> [demo](https://cdn.glitch.me/fd139a45-4a65-41b6-9634-41617ab20cdc/%E6%BC%94%E7%A4%BA.gif?v=1686907695067)
> [demo gif](https://cdn.glitch.me/fd139a45-4a65-41b6-9634-41617ab20cdc/%E6%BC%94%E7%A4%BA.gif?v=1686907695067)
+ **功能特点🐂:**
- 支持导入 DDL、DBML 和数据库逆向解析,AI 自动生成业务模型。
- 提供业务模型的基本 CRUD 功能、AI 智能分析,支持模型导出为 DDL、DBML 以及与数据库同步。
- 结合模型和 AI 实现自然语言数据查询,可添加至查询列表并通过 API 调用。
- BI分析、Function 调用、react代码沙箱、支持导入npm包。
## 应用场景🎬
......@@ -25,6 +24,14 @@
+ 非业务人员快速进行数据分析。
+ 更多应用场景待探索...
## deploy部署
+ docker compose
```shell
NEXT_PUBLIC_OPEN_AI_API_KEY="sk-..." docker-compose up
```
+ chat-query和chat-query-backend都是支持docker构建和提供docker镜像.
## 开发环境设置
> 👏 欢迎参与 Chat-Query 的建设。
......@@ -32,17 +39,34 @@
+ 后端:
```js
pnpm install
pnpm start:dev
```
- 在 .env 文件中添加 OPEN_AI_API_KEY='sk-...'等环境变量
- 在 .env 文件中添加
```shell
#openai
OPEN_AI_API_KEY='sk-...'
MODEL_NAME="gpt-3.5-turbo-16k-0613"
BASE_URL='https://open-ai-xyy.deno.dev/v1'
# database
DB_HOST="139.198.179.193"
DB_PORT=32094
```
+ 前端
```js
pnpm install
gitpnpm dev
pnpm dev
```
- 在 .env 文件中添加
```shell
NEXT_PUBLIC_OPEN_AI_API_KEY='sk-...'
OPENAI_PROXY_URL="https://open-ai-xyy.deno.dev/"
NEXT_PUBLIC_BACKEND_URL="http://localhost:3001/"
```
-在 .env 文件中添加 NEXT_PUBLIC_OPEN_AI_API_KEY='sk-...'
## 系统架构
......
# CHAT-QUERY
[中文](./README-zh.md)
[zh](./README-zh.md)
> Chat-Query is a data query tool based on metadata models and AI technology, enabling natural language queries.
> Chat-Query is a data query implementation based on metadata models and AI technology through natural language.
## Demo
> [view](https://chat-query.vercel.app/)
> [zh](http://139.198.179.193:30648/)
> [Online Preview](https://chat-query.vercel.app/)
> [demo](https://cdn.glitch.me/fd139a45-4a65-41b6-9634-41617ab20cdc/%E6%BC%94%E7%A4%BA.gif?v=1686907695067)
> [demo gif](https://cdn.glitch.me/fd139a45-4a65-41b6-9634-41617ab20cdc/%E6%BC%94%E7%A4%BA.gif?v=1686907695067)
+ **Features🐂:**
+ **Features🐂**
- Supports importing DDL, DBML, and reverse database parsing, with AI automatically generating business models.
- Provides basic CRUD functionality for business models, AI intelligent analysis, and supports exporting models as DDL, DBML, and synchronizing with databases.
- Combines models and AI to enable natural language data queries, which can be added to the query list and called via API.
- Supports DDL, DBML and database reverse parsing import, AI automatically generates business models.
- Provides basic CRUD functions of business models, AI intelligent analysis, supports model export to DDL, DBML and synchronization with the database.
- Combines models and AI to implement natural language data queries, can be added to the query list and called via API.
- BI analysis, Function call, react code sandbox, supports importing npm packages.
## Application Scenarios🎬
+ From low-code to no-code development.
+ Non-business users can quickly perform data analysis.
+ Non-business personnel can quickly perform data analysis.
+ More application scenarios to be explored...
## Deployment
+ docker compose
```shell
NEXT_PUBLIC_OPEN_AI_API_KEY="sk-..." docker-compose up
```
+ Both chat-query and chat-query-backend support docker build and provide docker images.
## Development Environment Setup
> 👏 Welcome to contribute to the development of Chat-Query.
> 👏 Welcome to participate in the construction of Chat-Query.
+ Backend:
+ Backend
```js
pnpm install
pnpm start:dev
```
- Add environement variables such as OPEN_AI_API_KEY = 'sk-...' to the .env file
- Add in .env file
```shell
#openai
OPEN_AI_API_KEY='sk-...'
MODEL_NAME="gpt-3.5-turbo-16k-0613"
BASE_URL='https://open-ai-xyy.deno.dev/v1'
# database
DB_HOST="139.198.179.193"
DB_PORT=32094
```
+ Frontend
......@@ -40,7 +59,13 @@
pnpm install
pnpm dev
```
- Add OPEN_AI_API_KEY='sk-...' in components/AITool/TOKEN.ts
- Add in .env file
```shell
NEXT_PUBLIC_OPEN_AI_API_KEY='sk-...'
OPENAI_PROXY_URL="https://open-ai-xyy.deno.dev/"
NEXT_PUBLIC_BACKEND_URL="http://localhost:3001/"
```
## System Architecture
......
......@@ -3,7 +3,7 @@
"version": "0.1.0",
"private": true,
"scripts": {
"dev": "next dev -p 4010",
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint"
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment