fix(readme)
Browse files
README.md
CHANGED
|
@@ -52,7 +52,7 @@ It allows users to:
|
|
| 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,7 +62,7 @@ app/
|
|
| 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
|
|
@@ -87,7 +87,7 @@ chroma_db/ # Vector DB storage (ignored in Git)
|
|
| 87 |
- ### JWT secret
|
| 88 |
- SECRET_KEY=your_super_secret_key
|
| 89 |
|
| 90 |
-
|
| 91 |
|
| 92 |
▶️ Run the App
|
| 93 |
|
|
|
|
| 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
|
|
|
|
| 87 |
- ### JWT secret
|
| 88 |
- SECRET_KEY=your_super_secret_key
|
| 89 |
|
| 90 |
+
⚠️ Never commit your real .env file.
|
| 91 |
|
| 92 |
▶️ Run the App
|
| 93 |
|