fix(readme)
Browse files
README.md
CHANGED
|
@@ -63,48 +63,48 @@ uploads/ # User uploaded files (ignored in Git)
|
|
| 63 |
chroma_db/ # Vector DB storage (ignored in Git)
|
| 64 |
|
| 65 |
## ⚙️ Setup & Installation
|
| 66 |
-
|
| 67 |
-
-
|
| 68 |
-
-
|
| 69 |
|
| 70 |
-
|
| 71 |
-
-
|
| 72 |
-
-
|
| 73 |
-
-
|
| 74 |
|
| 75 |
-
|
| 76 |
-
-
|
| 77 |
|
| 78 |
-
|
| 79 |
|
| 80 |
-
-
|
| 81 |
|
| 82 |
-
-
|
| 83 |
-
-
|
| 84 |
|
| 85 |
-
-
|
| 86 |
-
-
|
| 87 |
|
| 88 |
-
-
|
| 89 |
|
| 90 |
-
|
| 91 |
|
| 92 |
-
-
|
| 93 |
|
| 94 |
-
-
|
| 95 |
|
| 96 |
|
| 97 |
-
-
|
| 98 |
-
-
|
| 99 |
|
| 100 |
|
| 101 |
## 🔑 Authentication Flow
|
| 102 |
|
| 103 |
-
-
|
| 104 |
|
| 105 |
-
-
|
| 106 |
|
| 107 |
-
-
|
| 108 |
|
| 109 |
## 📂 Document Workflow
|
| 110 |
|
|
|
|
| 63 |
chroma_db/ # Vector DB storage (ignored in Git)
|
| 64 |
|
| 65 |
## ⚙️ Setup & Installation
|
| 66 |
+
1️⃣ Clone the repo
|
| 67 |
+
- git clone https://github.com/your-username/fastapi-rag-app.git
|
| 68 |
+
- cd fastapi-rag-app
|
| 69 |
|
| 70 |
+
2️⃣ Create & activate virtual environment
|
| 71 |
+
- python -m venv venv
|
| 72 |
+
- source venv/bin/activate # Linux/Mac
|
| 73 |
+
- venv\Scripts\activate # Windows
|
| 74 |
|
| 75 |
+
3️⃣ Install dependencies
|
| 76 |
+
- pip install -r requirements.txt
|
| 77 |
|
| 78 |
+
4️⃣ Configure environment variables
|
| 79 |
|
| 80 |
+
- Create a .env file in the project root (or copy from .env.example):
|
| 81 |
|
| 82 |
+
- ### OpenRouter
|
| 83 |
+
- OPENROUTER=your_openrouter_api_key_here
|
| 84 |
|
| 85 |
+
- ### JWT secret
|
| 86 |
+
- SECRET_KEY=your_super_secret_key
|
| 87 |
|
| 88 |
+
- ⚠️ Never commit your real .env file.
|
| 89 |
|
| 90 |
+
▶️ Run the App
|
| 91 |
|
| 92 |
+
- Start the FastAPI server:
|
| 93 |
|
| 94 |
+
- uvicorn app.main:app --reload
|
| 95 |
|
| 96 |
|
| 97 |
+
- The API will be available at:
|
| 98 |
+
- 👉 http://127.0.0.1:8000
|
| 99 |
|
| 100 |
|
| 101 |
## 🔑 Authentication Flow
|
| 102 |
|
| 103 |
+
- Signup → POST /signup with username & password
|
| 104 |
|
| 105 |
+
- Signin → POST /signin to receive access_token & refresh_token
|
| 106 |
|
| 107 |
+
- Use Authorization: Bearer <access_token> for protected endpoints
|
| 108 |
|
| 109 |
## 📂 Document Workflow
|
| 110 |
|