|
4 | 4 |
|
5 | 5 | ## ✨ Key Features |
6 | 6 |
|
7 | | -- **🎯 Accurate Answers**: Never hallucinates - responses are grounded in your uploaded documents |
| 7 | +- **🎯 Grounded Answers**: Uses retrieved document context, surfaces document sources, and clearly says it cannot answer when evidence is missing |
8 | 8 | - **📚 Multiple Knowledge Bases**: Organize documents by topic, department, or project |
9 | 9 | - **🤖 100+ AI Models**: Access OpenAI, Anthropic, Google, and more through OpenRouter |
10 | 10 | - **⚡ Real-time Streaming**: Get responses as they're generated |
@@ -61,6 +61,32 @@ uvicorn backend.main:app --reload --host 0.0.0.0 --port 8000 |
61 | 61 | # Frontend: http://localhost:5173 (after cd frontend && npm run dev) |
62 | 62 | ``` |
63 | 63 |
|
| 64 | +## 🐳 Docker Quick Start |
| 65 | + |
| 66 | +Prefer containers? The repository now ships with a full Docker setup for the API, frontend, PostgreSQL (with pgvector), and Redis. |
| 67 | + |
| 68 | +```bash |
| 69 | +# Build (or rebuild) the base dependency image and start everything |
| 70 | +./startupdocker.sh --build |
| 71 | + |
| 72 | +# Stream logs if you want to watch startup |
| 73 | +./startupdocker.sh --build --logs |
| 74 | + |
| 75 | +# Stop the stack when you're done |
| 76 | +./startupdocker.sh --down |
| 77 | +``` |
| 78 | + |
| 79 | +Host ports for the Docker stack: |
| 80 | + |
| 81 | +- Backend API: `http://localhost:18000` |
| 82 | +- Frontend UI: `http://localhost:15173` |
| 83 | +- PostgreSQL: `localhost:15432` (user/password: `ragify` / `RagifyStrongPass2023`) |
| 84 | +- Redis: `localhost:16379` |
| 85 | + |
| 86 | +The script automatically maintains a `ragify-backend-base` image that contains all heavy Python dependencies (Torch, transformers, etc.). The first `--build` run prepares that base; subsequent builds reuse it so only your application code is rebuilt unless `requirements-docker.txt` changes. |
| 87 | + |
| 88 | +Environment variables are loaded from the project’s `.env` file, so edit that file if you need to change keys, database credentials, or model configuration before running `./startupdocker.sh`. |
| 89 | + |
64 | 90 | ## 🎯 Why RAGify? |
65 | 91 |
|
66 | 92 | **Traditional AI chatbots often hallucinate** - they make up information that sounds plausible but isn't accurate. RAGify eliminates this by: |
@@ -110,4 +136,3 @@ black . && isort . |
110 | 136 | # Start development server |
111 | 137 | uvicorn backend.main:app --reload |
112 | 138 | ``` |
113 | | - |
|
0 commit comments