Hw 4

README.md

@@ -20,33 +20,92 @@
 
 *   **Бэкенд:** Python
 *   **Обработка данных и RAG:** LangChain / LangGraph / Tree-sitter
-*   **Векторная БД:** ChromaDB (для локальной разработки) / FAISS
+*   **Векторная БД:** QDrant
 *   **LLM:** Любая модель с OpenAI API (Gemini, Qwen3, etc.)
-*   **Веб-интерфейс (UI):** Streamlit / Gradio
+*   **Веб-интерфейс (UI):** Gradio
+
+На время тестирования решение доступно по ссылке: http://138.124.66.50:8501
 
 ## 🚀 Как начать (Getting Started)
 
-1.  **Клонируйте репозиторий:**
-    ```bash
-    git clone https://github.com/Alex777Russia/code-rag.git
-    cd code-rag
-    ```
+Вы можете использовать готовый Docker-Compose файл, либо установить все зависимости вручную.
+
+Прежде всего необходимо склонировать репозиторий:
+```bash
+git clone https://github.com/Alex777Russia/mlsd-code-rag.git
+```
+
+#### 1. Docker (рекомендуемый способ)
+
+Положить в файл [docker/.env](./docker/) свой API ключ Openrouter/Jina (в текущей версии используется Openrouter), пример можно посмотреть - [здесь](docker/.env_example).
+
+Установка зависимостей:
+
+```bash
+bash docker/build.sh
+```
+
+Запуск приложения:
+
+```bash
+bash docker/run.sh
+```
+
+В конце нужно открыть приложение в браузере по ссылке:
+
+```
+http://0.0.0.0:8501
+```
+
+Чтобы остановить приложение:
+```
+bash docker/stop.sh
+```
+
+#### 2. Вручную
+
+Положить в файл .env свой API ключ Openrouter/Jina (в текущей версии используется Openrouter), пример можно посмотреть - [здесь](docker/.env_example).
+
+Установка [uv](https://github.com/astral-sh/uv):
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Установка зависимостей:
+
+```bash
+uv sync
+```
+
+Затем необходимо загрузить образ базы данных Qdrant:
+
+```bash
+docker pull qdrant/qdrant
+```
+
+Затем нужно в отдельном терменале запустить сервер с Qdrant:
+
+```bash
+docker run -p 6333:6333 -p 6334:6334 -v qdrant_storage:/qdrant/storage qdrant/qdrant
+```
+
+И затем запустить приложение:
+
+```bash
+uv run python app.py
+```
 
-2.  **Установите зависимости:**
-    ```bash
-    pip install -r requirements.txt
-    ```
+В конце нужно открыть приложение в браузере по ссылке:
 
-3.  **Настройте переменные окружения:**
-    Создайте файл `.env` и добавьте ваш API ключ для LLM.
-    ```
-    OPENAI_API_KEY="..."
-    ```
+```
+http://0.0.0.0:8501
+```
 
-4.  **Запустите сервис:**
-    ```bash
-    # Инструкции по запуску будут добавлены позже
-    ```
+Чтобы остановить приложение нужно остановить нажать CTLR + C и остановить контейнер с Qdrant:
+```
+docker stop <qdrant_container_id> (id можно посмотреть с помощью команды docker ps)
+```
 
 ## 🗺️ Дорожная карта (Roadmap)
 
@@ -63,4 +122,4 @@
 
 ## 📄 Лицензия
 
-Этот проект распространяется под лицензией MIT. Подробности смотрите в файле `LICENSE`.
+Этот проект распространяется под лицензией MIT. Подробности смотрите в файле `LICENSE`.