瀏覽代碼

Docs: Update full stack docs (#1230)

Taranjeet Singh 1 年之前
父節點
當前提交
34c41c87dc
共有 2 個文件被更改,包括 19 次插入0 次删除
  1. 19 0
      docs/get-started/full-stack.mdx
  2. 二進制
      docs/images/fullstack-api-server.png

+ 19 - 0
docs/get-started/full-stack.mdx

@@ -8,6 +8,9 @@ Get started with full-stack RAG applications using Embedchain's easy-to-use CLI
 
 Choose your setup method:
 
+* [Without docker](#without-docker)
+* [With Docker](#with-docker)
+
 ### Without Docker
 
 Ensure these are installed:
@@ -21,6 +24,14 @@ Install Docker from [Docker's official website](https://docs.docker.com/engine/i
 
 ## Quick Start Guide
 
+### Install the package
+
+Before proceeding, make sure you have the Embedchain package installed.
+
+```bash
+pip install embedchain -U
+```
+
 ### Setting Up
 
 For the purpose of the demo, you have to set `OPENAI_API_KEY` to start with but you can choose any llm by changing the configuration easily.
@@ -60,3 +71,11 @@ Open http://localhost:3000 to view the chat UI.
 Check out the Embedchain admin panel to see the document chunks for your RAG application.
 
 ![full stack chunks](/images/fullstack-chunks.png)
+
+### API Server
+
+If you want to access the API server, you can do so at http://localhost:8000/docs.
+
+![API Server](/images/fullstack-api-server.png)
+
+You can customize the UI and code as per your requirements.

二進制
docs/images/fullstack-api-server.png