mirror of
https://github.com/sqlchat/sqlchat.git
synced 2026-03-13 07:59:44 +08:00
chore: improve readme
This commit is contained in:
41
README.md
41
README.md
@@ -1,11 +1,44 @@
|
||||
# SQL Chat
|
||||

|
||||
|
||||
### One-Click Deploy to Vercel
|
||||
<div align="center">
|
||||
<h3>SQL Chat</h3>
|
||||
<a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fbytebase%2Fsqlchat&env=OPENAI_API_KEY"><img src="https://img.shields.io/badge/deploy%20on-Vercel-brightgreen.svg?style=for-the-badge&logo=vercel" alt="vercel"></a>
|
||||
</div>
|
||||
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fbytebase%2Fsqlchat&env=OPENAI_API_KEY)
|
||||
## What
|
||||
|
||||
### Development
|
||||
SQL Chat is a chat based SQL Client.
|
||||
|
||||

|
||||
## Why
|
||||
|
||||
As we enter the [Developer Tools 2.0 era](https://www.sequoiacap.com/article/ai-powered-developer-tools/),
|
||||
there is a massive opportunity to rebuild the existing tools using chat-based interface. SQL Client
|
||||
is no exception. Instead of navigating across many UI controls, a chat-based interface is much
|
||||
more intuitive. Of course, only if that works, and our goal is to deliver that experience.
|
||||
|
||||
## How
|
||||
|
||||
SQL Chat is built by Next.js, it supports following databases and will add more over the time:
|
||||
* MySQL
|
||||
* PostgreSQL
|
||||
|
||||
## Data Privacy
|
||||
|
||||
All database conenction configs are stored locally in your browser. You can also visit settings to
|
||||
clear the data.
|
||||
|
||||
## Local Development
|
||||
|
||||
```bash
|
||||
pnpm i && pnpm dev
|
||||
```
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://star-history.com/#bytebase/sqlchat&Date)
|
||||
|
||||
|
||||
## License
|
||||
|
||||
This project is under the BSL License. See the [LICENSE](LICENSE) file for the full license text.
|
||||
|
||||
BIN
public/banner.png.webp
Normal file
BIN
public/banner.png.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 148 KiB |
BIN
public/screenshot1.webp
Normal file
BIN
public/screenshot1.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Reference in New Issue
Block a user