Junranl commited on
Commit
4673f6d
Β·
verified Β·
1 Parent(s): 6e1a53e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -72
README.md CHANGED
@@ -1,72 +1,6 @@
1
- # Embedchain Admin
2
-
3
- Welcome to the Embedchain Admin repository. This toolkit helps you build a full-stack RAG (Retrieve, Append, Generate) application with a focus on simplicity and functionality, powered by Embedchain.
4
-
5
- ## πŸš€ Features
6
-
7
- - **Chat Interface:** A clean and simple interface for messaging.
8
- - **Streaming:** Supports live data streaming.
9
- - **Citations:** Allows integration of citations within the chat.
10
- - **Model Support:** Compatible with both proprietary and open-source models.
11
- - **Admin Panel:**
12
- - View chat history.
13
- - Manage embeddings.
14
- - Configure data sources through the UI.
15
-
16
- ## Tech Stack
17
-
18
- This project uses:
19
-
20
- - FastAPI: For the backend, making it fast and easy to develop.
21
- - NextJS: For the frontend, enabling responsive and dynamic web pages.
22
- - Embedchain: Powers the core functionalities like chat and streaming.
23
-
24
-
25
- ## Getting Started
26
-
27
- To start using Embedchain Admin for your project, install python package using:
28
-
29
- ```bash
30
- pip install embedchain
31
- ```
32
-
33
- Now, if you use docker, you can simply run the following commands:
34
-
35
- ### With docker
36
- ```bash
37
- ec create-app my-app --docker
38
- cd my-app
39
- ec start --docker
40
- ```
41
-
42
- ### Without docker
43
-
44
- ```bash
45
- ec create-app my-app
46
- cd my-app
47
- ec start
48
- ```
49
-
50
- You are all set now. Open http://localhost:3000 to view the chat UI.
51
-
52
- ## Screenshots
53
-
54
- ### Chat
55
-
56
- <img src="assets/chat.png" height="600px" />
57
-
58
- ### Search
59
-
60
- <img src="assets/search.png" height="600px" />
61
-
62
- ### Chat history
63
-
64
- <img src="assets/chat_history.png" height="600px" />
65
-
66
- ### Collections
67
-
68
- <img src="assets/collection.png" height="600px" />
69
-
70
- ### Data sources
71
-
72
- <img src="assets/add_data.png" height="600px" />
 
1
+ title: Rag-full
2
+ emoji: πŸŒ–
3
+ colorFrom: blue
4
+ colorTo: red
5
+ sdk: docker
6
+ pinned: false