Introduction to DB-GPT-Web
DB-GPT-Web is an open-source chat user interface designed specifically for the DB-GPT project. This UI work seamlessly with large language models (LLM) to create an engaging and interactive visual solution. Designed using Tailwind CSS and Next.js, DB-GPT-Web provides an aesthetically pleasing interface for AI and GPT-driven projects. It offers advanced markup capabilities, including enhanced markdown elements like tables and headings, as well as custom tags for AI-specific operations such as plugin management and chart visualization.
Getting Started
Prerequisites
To get started with DB-GPT-Web, you need the following:
- Node.js version 16 or higher.
- npm version 8 or higher.
- Compatible with major operating systems such as Linux, macOS, and Windows.
Installation
To install the necessary dependencies, you can run the following command in your terminal:
npm install
Usage
-
Copy the environment configuration file:
cp .env.example .env
Modify the
API_BASE_URL
field in the configuration file to your actual API endpoint. -
To enter the development mode, run:
npm run dev
Use in DB-GPT
For integrating with DB-GPT, follow these steps:
-
Compile the project:
npm run compile
-
Copy the compiled files to the static directory of DB-GPT:
cp -rf out/* ../dbgpt/app/static
Documentation
For a comprehensive guide on using and developing DB-GPT-Web, check out the documentation.
Technical Stack
DB-GPT-Web utilizes several technologies to achieve its robust capabilities:
- react-markdown for rendering markdown content dynamically.
- ant-design to provide ready-to-use UI components.
- next.js for efficient server-side rendering.
- @antv/g2 for creating sophisticated data charts.
License
DB-GPT-Web is open-source and is licensed under the MIT License, allowing for wide usage and alteration by other developers.
Enjoy the ease of creating visually stunning interfaces for your AI and GPT projects with DB-GPT-Web. If you find it helpful or have queries, consider supporting the project with a star on GitHub, or raise an issue for discussion. Happy coding! 😊