fix(readme)
Browse files
README.md
CHANGED
|
@@ -44,14 +44,15 @@ It allows users to:
|
|
| 44 |
- ChromaDB
|
| 45 |
|
| 46 |
- SQLModel
|
| 47 |
-
-
|
| 48 |
|
| 49 |
- HuggingFace Embeddings
|
| 50 |
|
| 51 |
- OpenRouter
|
| 52 |
-
-
|
| 53 |
|
| 54 |
## 📂 Project Structure
|
|
|
|
| 55 |
app/
|
| 56 |
├── main.py # FastAPI routes & entrypoint
|
| 57 |
├── rag.py # RAG pipeline (embeddings, vector store, QA chain)
|
|
@@ -61,6 +62,7 @@ app/
|
|
| 61 |
└── config.py # Settings & constants
|
| 62 |
uploads/ # User uploaded files (ignored in Git)
|
| 63 |
chroma_db/ # Vector DB storage (ignored in Git)
|
|
|
|
| 64 |
|
| 65 |
## ⚙️ Setup & Installation
|
| 66 |
1️⃣ Clone the repo
|
|
|
|
| 44 |
- ChromaDB
|
| 45 |
|
| 46 |
- SQLModel
|
| 47 |
+
- for user database
|
| 48 |
|
| 49 |
- HuggingFace Embeddings
|
| 50 |
|
| 51 |
- OpenRouter
|
| 52 |
+
- (for LLM access)
|
| 53 |
|
| 54 |
## 📂 Project Structure
|
| 55 |
+
````` ```````
|
| 56 |
app/
|
| 57 |
├── main.py # FastAPI routes & entrypoint
|
| 58 |
├── rag.py # RAG pipeline (embeddings, vector store, QA chain)
|
|
|
|
| 62 |
└── config.py # Settings & constants
|
| 63 |
uploads/ # User uploaded files (ignored in Git)
|
| 64 |
chroma_db/ # Vector DB storage (ignored in Git)
|
| 65 |
+
````` ```````
|
| 66 |
|
| 67 |
## ⚙️ Setup & Installation
|
| 68 |
1️⃣ Clone the repo
|