docs (#165)

* perf: log * README * docs
2025-10-15 07:31:19 +00:00 · 2023-08-10 14:26:10 +08:00
parent 4dc0fd3c3f
commit a0c397cfd2
9 changed files with 209 additions and 34 deletions
--- a/README_en.md
+++ b/README_en.md
@@ -0,0 +1,115 @@
+<div align="center">
+<a href="https://fastgpt.run/"><img src="/.github/imgs/logo.png" width="100" height="100" alt="fastgpt logo"></a>
+
+# FastGPT
+
+FastGPT is a knowledge-based question answering system based on the LLM language model, providing out-of-the-box capabilities for data processing, model invocation, and more. It also allows for complex question answering scenarios through visual workflow orchestration using Flow!
+
+</div>
+
+<p align="center">
+<a href="https://fastgpt.run/">Online</a>
+·
+<a href="https://doc.fastgpt.run/docs/intro">Document</a>
+·
+<a href="https://doc.fastgpt.run/docs/develop/dev">Development</a>
+·
+<a href="https://doc.fastgpt.run/docs/category/deploy">Deploy</a>
+·
+<a href="#powered-by">Power By</a>
+</p>
+
+## 🛸 Online
+
+[fastgpt.run](https://fastgpt.run/)
+| | |
+| ---------------------------------- | ---------------------------------- |
+| ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
+| ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
+
+## 💡 Features
+
+1. Powerful visual orchestration for easy AI application building
+
+   - [x] Provides a simple mode without the need for orchestration operations
+   - [x] User dialogue pre-guidance
+   - [x] Global variables
+   - [x] Knowledge base search
+   - [x] Multi-LLM model dialogue
+   - [x] Extraction of text content into structured data
+   - [x] HTTP extension
+   - [ ] Sandbox JS runtime module
+   - [ ] Continuous dialogue guidance
+   - [ ] Dialogue multi-path selection
+   - [ ] Source file reference tracking
+
+2. Rich knowledge base preprocessing
+
+   - [x] Multiple library reuse and mixing
+   - [x] Chunk record modification and deletion
+   - [x] Supports direct segment import
+   - [x] Supports QA split import
+   - [x] Supports manual input content
+   - [ ] Supports URL import reading
+   - [x] Supports batch import of Q&A pairs in CSV format
+   - [ ] Supports separate vector model settings for knowledge bases
+   - [ ] Source file storage
+
+3. Multiple effect testing channels
+
+   - [x] Knowledge base single point search testing
+   - [x] Feedback references and ability to modify and delete during dialogue
+   - [x] Complete context presentation
+   - [ ] Complete module intermediate value presentation
+
+4. OpenAPI
+
+   - [x] completions interface (aligned with GPT interface)
+   - [ ] Knowledge base CRUD
+
+5. Operational functions
+
+   - [x] Login-free sharing window
+   - [x] One-click embedding with Iframe
+   - [ ] Unified access to dialogue records
+
+## 👨‍💻 Development
+
+Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin)
+
+- [Getting Started with Local Development](https://doc.fastgpt.run/docs/develop/dev)
+- [Deploying FastGPT](https://doc.fastgpt.run/docs/category/deploy)
+- [System Configuration File Explanation](https://doc.fastgpt.run/docs/category/data-config)
+- [Multi-model Configuration](https://doc.fastgpt.run/docs/develop/data_config/chat_models)
+- [V3 Upgrade V4 Initialization](https://doc.fastgpt.run/docs/develop/deploy/v4init)
+
+<!-- ## :point_right: RoadMap
+- [FastGpt RoadMap](https://kjqvjse66l.feishu.cn/docx/RVUxdqE2WolDYyxEKATcM0XXnte) -->
+
+<!-- ## 🏘️ Community
+
+| Community Group                                   | Assistant                                      |
+| ------------------------------------------------- | ---------------------------------------------- |
+| ![](https://otnvvf-imgs.oss.laf.run/wxqun300.jpg) | ![](https://otnvvf-imgs.oss.laf.run/wx300.jpg) | -->
+
+## 👀 Others
+
+- [FastGpt FAQ](https://kjqvjse66l.feishu.cn/docx/HtrgdT0pkonP4kxGx8qcu6XDnGh)
+- [Docker Deployment Tutorial Video](https://www.bilibili.com/video/BV1jo4y147fT/)
+- [Official Account Integration Video Tutorial](https://www.bilibili.com/video/BV1xh4y1t7fy/)
+- [FastGpt Knowledge Base Demo](https://www.bilibili.com/video/BV1Wo4y1p7i1/)
+
+## 💪 Related Projects
+
+- [Laf: 3-minute quick access to third-party applications](https://github.com/labring/laf)
+- [Sealos: Rapid deployment of cluster applications](https://github.com/labring/sealos)
+- [One API: Multi-model management, supports Azure, Wenxin Yiyuan, etc.](https://github.com/songquanpeng/one-api)
+- [TuShan: Build a backend management system in 5 minutes](https://github.com/msgbyte/tushan)
+
+## 🤝 Third-party Ecosystem
+
+- [luolinAI: Enterprise WeChat bot, ready to use](https://github.com/luolin-ai/FastGPT-Enterprise-WeChatbot)
+
+## 🌟 Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=labring/FastGPT&type=Date)](https://star-history.com/#labring/FastGPT&Date)