opensource/sqlchat
1
0
Fork 0
mirror of https://github.com/sqlchat/sqlchat.git synced 2025-09-26 17:45:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme for all locales

Browse Source
This commit is contained in:
Tianzhou Chen
2023-06-17 18:26:40 +08:00
parent d78a2ead53
commit eba28dd903
3 changed files with 41 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.es-ES.md
View File

@ -16,6 +16,8 @@ SQL Chat es un cliente SQL basado en chat, que utiliza lenguaje natural para com
![Screenshot](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/screenshot2.webp) ![Screenshot](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/screenshot2.webp)
![Screenshot](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/screenshot3.webp)
## ¿Por que? ## ¿Por que?
A medida que entramos en la [Era de las Herramientas de Desarrollo 2.0](https://www.sequoiacap.com/article/ai-powered-developer-tools/), A medida que entramos en la [Era de las Herramientas de Desarrollo 2.0](https://www.sequoiacap.com/article/ai-powered-developer-tools/),
@ -44,7 +46,7 @@ Si usas [sqlchat.ai](https://sqlchat.ai) para conectarte a tu base de datos, deb
## Hospedaje propio con Docker ## Hospedaje propio con Docker
```bash ```bash
docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat docker run --name sqlchat --platform linux/amd64 -env NEXTAUTH_SECRET=xxx -p 3000:3000 sqlchat/sqlchat
``` ```
### Variables relacionadas con OpenAI: ### Variables relacionadas con OpenAI:
@ -64,7 +66,7 @@ docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat
- `DATABASE_URL`: Aplicable si `NEXT_PUBLIC_DATABASE_LESS` es `false`. Cadena de conexión de Postgres para almacenar datos. ej. `postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat`. - `DATABASE_URL`: Aplicable si `NEXT_PUBLIC_DATABASE_LESS` es `false`. Cadena de conexión de Postgres para almacenar datos. ej. `postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat`.
```bash ```bash
docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env OPENAI_API_ENDPOINT=yyy -p 3000:3000 sqlchat/sqlchat docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET=xxx --env OPENAI_API_KEY=yyy --env OPENAI_API_ENDPOINT=zzz -p 3000:3000 sqlchat/sqlchat
``` ```
## Desarrollo Local ## Desarrollo Local
@ -75,13 +77,19 @@ docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env
pnpm i pnpm i
``` ```
2. Haga una copia del archivo de variables de entorno de ejemplo: 1. Haga una copia del archivo de variables de entorno de ejemplo:
```bash ```bash
cp .env.example .env cp .env.example .env
``` ```
3. Añade tu [clave de API](https://platform.openai.com/account/api-keys) y el endpoint del API de OpenAI(opcional) al recién creado archivo `.env`. 1. Generar el cliente prisma a partir del modelo.
```bash
pnpm prisma generate
```
1. Añade tu [clave de API](https://platform.openai.com/account/api-keys) y el endpoint del API de OpenAI(opcional) al recién creado archivo `.env`.
### Configura la base de datos ### Configura la base de datos
@ -89,7 +97,7 @@ docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env
1. Inicie una instancia de Postgres. Para mac, puedes usar [StackbBricks](https://stackbricks.app/), [DBngin](https://dbngin.com/) o [Postgres.app](https://postgresapp.com/). 1. Inicie una instancia de Postgres. Para mac, puedes usar [StackbBricks](https://stackbricks.app/), [DBngin](https://dbngin.com/) o [Postgres.app](https://postgresapp.com/).
2. Crea una base de datos: 1. Crea una base de datos:
```sql ```sql
CREATE DATABASE sqlchat; CREATE DATABASE sqlchat;
@ -97,21 +105,13 @@ docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env
En el archivo `.env`, asigna la cadena de conexión a la variable de entorno `DATABASE_URL` y `DATABASE_DIRECT_URL`. [Este articulo](https://www.prisma.io/docs/data-platform/data-proxy/prisma-cli-with-data-proxy#set-a-direct-database-connection-url-in-your-prisma-schema) explica por qué necesitamos dos URL. En el archivo `.env`, asigna la cadena de conexión a la variable de entorno `DATABASE_URL` y `DATABASE_DIRECT_URL`. [Este articulo](https://www.prisma.io/docs/data-platform/data-proxy/prisma-cli-with-data-proxy#set-a-direct-database-connection-url-in-your-prisma-schema) explica por qué necesitamos dos URL.
3. Generar esquema 1. Migrar esquema
1. Generar el cliente prisma a partir del modelo.
```bash
pnpm prisma generate
```
2. Migrar esquema
```bash ```bash
pnpm prisma migrate dev pnpm prisma migrate dev
``` ```
3. (Opcional) Seed data 1. (Opcional) Seed data
```bash ```bash
pnpm prisma db seed pnpm prisma db seed

4
README.md
View File

@ -46,7 +46,7 @@ to the database whitelist IP. Because sqlchat.AI is hosted on [Vercel](https://v
## Self-host with Docker ## Self-host with Docker
```bash ```bash
docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat docker run --name sqlchat --platform linux/amd64 -env NEXTAUTH_SECRET=xxx -p 3000:3000 sqlchat/sqlchat
``` ```
### OpenAI related variables: ### OpenAI related variables:
@ -66,7 +66,7 @@ docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat
- `DATABASE_URL`: Applicable if `NEXT_PUBLIC_DATABASE_LESS` is `false`. Postgres connection string to store data. e.g. `postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat`. - `DATABASE_URL`: Applicable if `NEXT_PUBLIC_DATABASE_LESS` is `false`. Postgres connection string to store data. e.g. `postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat`.
```bash ```bash
docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env OPENAI_API_ENDPOINT=yyy --env NEXTAUTH_SECRET=zzz -p 3000:3000 sqlchat/sqlchat docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET=xxx --env OPENAI_API_KEY=yyy --env OPENAI_API_ENDPOINT=zzz -p 3000:3000 sqlchat/sqlchat
``` ```
## Local Development ## Local Development

23
README.zh-CN.md
View File

@ -16,6 +16,8 @@ SQL Chat 是一个基于聊天的 SQL 客户端，使用自然语言与数据库
![Screenshot](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/screenshot2.webp) ![Screenshot](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/screenshot2.webp)
![Screenshot](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/screenshot3.webp)
## 为什么会出现 SQL Chat ## 为什么会出现 SQL Chat
随着我们进入 [开发者工具 2.0 时代](https://www.sequoiacap.com/article/ai-powered-developer-tools/)，使用基于聊天的界面重建现有工具的机会非常大。SQL Client 也不例外。与在许多 UI 控件之间导航不同，基于聊天的界面更加直观。当然，前提是那可行，而我们的目标就是提供这种体验。 随着我们进入 [开发者工具 2.0 时代](https://www.sequoiacap.com/article/ai-powered-developer-tools/)，使用基于聊天的界面重建现有工具的机会非常大。SQL Client 也不例外。与在许多 UI 控件之间导航不同，基于聊天的界面更加直观。当然，前提是那可行，而我们的目标就是提供这种体验。
@ -44,7 +46,7 @@ SQL Chat 是由 [Next.js](https://nextjs.org/) 构建的，它支持以下数据
## 使用 Docker 自托管 ## 使用 Docker 自托管
```bash ```bash
docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat docker run --name sqlchat --platform linux/amd64 -env NEXTAUTH_SECRET=xxx -p 3000:3000 sqlchat/sqlchat
``` ```
### OpenAI 相关变量: ### OpenAI 相关变量:
@ -62,7 +64,7 @@ docker run --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat
- `DATABASE_URL`: 只有在 NEXT_PUBLIC_DATABASE_LESS 为 true 时有效。Postgres 数据库连接串 e.g. `postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat`. - `DATABASE_URL`: 只有在 NEXT_PUBLIC_DATABASE_LESS 为 true 时有效。Postgres 数据库连接串 e.g. `postgresql://postgres:YOUR_PASSWORD@localhost:5432/sqlchat?schema=sqlchat`.
```bash ```bash
docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env OPENAI_API_ENDPOINT=yyy -p 3000:3000 sqlchat/sqlchat docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET=xxx --env OPENAI_API_KEY=yyy --env OPENAI_API_ENDPOINT=zzz -p 3000:3000 sqlchat/sqlchat
``` ```
## 本地开发环境 ## 本地开发环境
@ -79,6 +81,12 @@ docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env
cp .env.example .env cp .env.example .env
``` ```
1. 生成 `prisma` 客户端
```bash
pnpm prisma generate
```
1. 将您的 [API 密钥](https://platform.openai.com/account/api-keys) 和 `OpenAI API` 端点（可选）添加到新创建的 `.env` 文件; 1. 将您的 [API 密钥](https://platform.openai.com/account/api-keys) 和 `OpenAI API` 端点（可选）添加到新创建的 `.env` 文件;
### 配置数据库 ### 配置数据库
@ -93,21 +101,14 @@ docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env
在 `.env` 文件中, 将连接字符串分配给环境变量 `DATABASE_URL` 和 `DATABASE_DIRECT_URL`。至于需要两个 URL 的原因[见此](https://www.prisma.io/docs/data-platform/data-proxy/prisma-cli-with-data-proxy#set-a-direct-database-connection-url-in-your-prisma-schema). 在 `.env` 文件中, 将连接字符串分配给环境变量 `DATABASE_URL` 和 `DATABASE_DIRECT_URL`。至于需要两个 URL 的原因[见此](https://www.prisma.io/docs/data-platform/data-proxy/prisma-cli-with-data-proxy#set-a-direct-database-connection-url-in-your-prisma-schema).
1. 生成 schema
1. 从模型生成 `prisma` 客户端 1. 设置数据库 schema
```bash
pnpm prisma generate
```
2. 迁移 schema
```bash ```bash
pnpm prisma migrate dev pnpm prisma migrate dev
``` ```
3. 初始化数据（可选） 1. 初始化数据（可选）
```bash ```bash
pnpm prisma db seed pnpm prisma db seed