From 7e9013bca247878f9d211ea2ab42c64905bb0aab Mon Sep 17 00:00:00 2001 From: maninhill <41712985+maninhill@users.noreply.github.com> Date: Mon, 21 Apr 2025 14:18:57 +0800 Subject: [PATCH] chore: Update README.md --- README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 61 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 90bb2b2a..dd5ea0cd 100644 --- a/README.md +++ b/README.md @@ -1 +1,61 @@ -# SQLBot \ No newline at end of file +

SQLBot

+

Chat with your SQL database

+

+ License: GPL v3 + Latest release + Stars + Download
+ [中文(简体)] | [English] +

+
+ +SQLChat allows you to interact with your SQL database through advanced Text-to-SQL technology. This capability is powered by Large Language Models (LLMs) and Retrieval-Augmented Generation (RAG). + +- **TBD**: TBD. +- **TBD**: TBD. +- **TBD**: TBD. +- **TBD**: TBD. + +## Quick start + +Execute the script below to start a SQLBot container using Docker: + +```bash +docker run -d --name=sqlbot --restart=always -p 8080:8080 -v ~/.sqlbot:/var/lib/postgresql/data 1panel/sqlbot +``` + +Access SQLbot web interface at `http://your_server_ip:8080` with default admin credentials: + +- username: admin +- password: SQLBot@123.. + +## Screenshots + + + + + + + + + + +
SQLBot Demo1SQLBot Demo2
SQLBot Demo3SQLBot Demo4
+ +## Technical stack + +- Frontend:[Vue.js](https://vuejs.org/) +- Backend:[Python / Django](https://www.djangoproject.com/) +- Database:[PostgreSQL + pgvector](https://www.postgresql.org/) + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=1Panel-dev/SQLBot&type=Date)](https://star-history.com/#1Panel-dev/SQLBot&Date) + +## License + +Licensed under The GNU General Public License version 3 (GPLv3) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + + + +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.