Skip to content

trialiya/knowledge-base

Repository files navigation

Knowledge Base

AI-ассистент для работы с документацией и анализа кодовой базы.

Для чего

Knowledge Base помогает вести документацию, анализировать изменения и быстро находить ответы в проекте. AI-чат понимает содержимое базы знаний и Git-репозитория — можно спрашивать о коде, коммитах, архитектуре на естественном языке.

Для кого

  • Разработчик — AI-ассистент, который знает код проекта: найдёт нужный файл, покажет историю изменений, объяснит архитектуру. Структурный анализ кода (tree-sitter), grep по репозиторию, diff коммитов.
  • Аналитик / тимлид — единое хранилище документации с AI-поиском. Импорт из Jira и Confluence, история изменений с восстановлением версий, экспорт в Markdown.
  • ПО / технический писатель — Markdown-редактор с живым предпросмотром, древовидная структура, AI-саммаризация документов.

Что умеет

  • 📁 База знаний — папки и документы с древовидной структурой
  • ✏️ Markdown-редактор — создание и редактирование с живым предпросмотром
  • 🤖 AI-чат — ассистент, который отвечает на основе базы знаний и кода
  • 🔍 Гибридный поиск — keyword + смысловой (векторный) поиск
  • 🐙 Git-анализ — чтение файлов, коммитов, диффов, grep, структурный анализ
  • 📎 Вложения — загрузка файлов к документам и чатам
  • 📤 Экспорт — выгрузка базы знаний в файловую систему
  • 🔗 Atlassian — импорт из Jira и Confluence
  • 🐳 Docker — готовый compose-файл для быстрого развёртывания

Быстрый старт

cd docker
cp example.env .env
# Укажите AI_API_KEY, AI_BASE_URL, AI_MODEL и PROJECT_PATH_MOUNT
docker compose -f docker-compose-h2.yaml up

Открывайте http://localhost:8080 — приложение готово к работе.

Что внутри: встроенная H2 (PostgreSQL не нужен), keyword-поиск, AI-чат, Git-интеграция. Семантический поиск отключён — для полного стека замените docker-compose-h2.yaml на docker compose up.

Пошаговая инструкция — Руководство по установке

Без Docker — запуск из JAR

./gradlew :backend:bootJar          # фронтенд встраивается автоматически
SPRING_PROFILES_ACTIVE=h2 \
AI_BASE_URL=https://api.openai.com/ AI_API_KEY=your-key AI_MODEL=gpt-4o \
PROJECT_PATH=./ \
java -jar backend/build/libs/backend-1.0-SNAPSHOT.jar

Требуется JDK 25. Подробнее — Руководство по установке, раздел 4.

Документация

Документ О чём
Введение Обзор проекта и всех возможностей
Архитектура Схема слоёв, стек технологий, сервисы
Фронтенд — обзор архитектуры React 19, навигация, стриминг, Markdown
Модели данных Сущности, DTO, связи между таблицами
API Reference Все эндпоинты с параметрами
AI-инструменты Инструменты ассистента (24 шт.)
Конфигурация Переменные окружения, Docker, настройки
Руководство по установке Требования, запуск, устранение проблем
Разработка и контрибьюция Сборка, тестирование, стиль кода
Обзор чат-системы Архитектура чата, SSE, стриминг
Чат — руководство пользователя Как пользоваться чатом
База знаний — руководство пользователя Навигация, поиск, AI-саммаризация
Поиск — руководство пользователя Гибридный поиск, настройки
Экспорт документов Выгрузка базы в файловую систему

Стек технологий

Компонент Технологии
Бэкенд Java 25, Spring Boot 3.5, Spring AI, PostgreSQL 17 + pgvector
Фронтенд React 19, CSS
Инфраструктура Docker, docker-compose

Подробно — Архитектура

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors