Update README.md
Browse files
README.md
CHANGED
|
@@ -1,11 +1,44 @@
|
|
| 1 |
---
|
| 2 |
-
title: Study RAG
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
-
license: mit
|
| 9 |
---
|
| 10 |
|
| 11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Study RAG Assistant UI Mock
|
| 3 |
+
emoji: 📚
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: indigo
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
|
|
|
| 8 |
---
|
| 9 |
|
| 10 |
+
# Study RAG Assistant (UI Mock)
|
| 11 |
+
|
| 12 |
+
This Space hosts a **frontend UI mock** for a "Study RAG Assistant" that supports:
|
| 13 |
+
- Uploading up to **10 Jupyter notebooks (.ipynb)** and **5 PDFs**
|
| 14 |
+
- Browsing sources
|
| 15 |
+
- Chat / Notes / Quiz tabs
|
| 16 |
+
- Citation-style UI components
|
| 17 |
+
- Preview modal (mock)
|
| 18 |
+
|
| 19 |
+
✅ **Note:** This Space is a **static UI only** (no backend connected yet).
|
| 20 |
+
It is meant to help decide the interface before wiring the real RAG pipeline.
|
| 21 |
+
|
| 22 |
+
---
|
| 23 |
+
|
| 24 |
+
## ✅ How to Deploy (Hugging Face Spaces)
|
| 25 |
+
|
| 26 |
+
### 1) Create a new Space
|
| 27 |
+
- Go to **Hugging Face → Spaces → Create new Space**
|
| 28 |
+
- Choose **SDK: Static**
|
| 29 |
+
- Name it anything (e.g., `study-rag-ui`)
|
| 30 |
+
|
| 31 |
+
### 2) Upload these files into the Space repo
|
| 32 |
+
Required:
|
| 33 |
+
- `index.html` ← (your UI HTML file)
|
| 34 |
+
|
| 35 |
+
Optional:
|
| 36 |
+
- `README.md` (this file)
|
| 37 |
+
|
| 38 |
+
### 3) Done
|
| 39 |
+
Hugging Face will automatically serve `index.html`.
|
| 40 |
+
|
| 41 |
+
---
|
| 42 |
+
|
| 43 |
+
## 📁 Expected Repo Structure
|
| 44 |
+
|