На этой странице

Работа с локальной копией

Запустите нужные компоненты

Запустите Docker. Создайте приватный config/.env по шаблону и задайте учётные данные разработки. Для текста в UTF-8 на локальной файловой системе установите в этом файле EXTRACTOR_BACKEND=local и FILE_STORAGE_BACKEND=local.

Выполните команды из корня репозитория.

contextbase_dev() {
  docker compose --project-directory . -f compose/docker-compose.yml \
    -f compose/docker-compose.override.yml "$@"
}

contextbase_dev up -d --wait db pgbouncer redis
contextbase_dev run --rm --build web /bin/sh /code/docker/django/admin.sh \
  python manage.py migrate --noinput
contextbase_dev up -d --wait web worker beat
curl --fail 'http://localhost:8000/health/?format=json'

Базовый файл Compose направляет обычные подключения к БД через PgBouncer. admin.sh подключается напрямую. Слой разработки подключает исходники к API, воркеру и планировщику. Если нужно попробовать продукт на примере, используйте быстрый старт.

Запустите веб-интерфейс

Для этого шага нужны запущенный API и поддерживаемая версия Node. Установите зависимости и запустите Next.js из корня репозитория.

npm --prefix frontend ci
cd frontend
NEXT_PUBLIC_API_BASE_URL=http://localhost:8000 npm run dev

Откройте http://localhost:3000. Если измените адрес веб-интерфейса, добавьте его origin в FRONTEND_ORIGINS на сервере. Без адреса API в параметрах сборки клиент отправляет запросы на origin открытой страницы. Так работает штатный шлюз. Настройка фронтенда

Выберите инструменты, указанные в репозитории

Для проверок на хосте возьмите версии Python, Poetry и системных пакетов и Node из репозитория. Из корня установите зависимости для компонентов, которые проверяете.

poetry sync
npm --prefix frontend ci
npm --prefix sdk/typescript ci
uv --directory sdk/python sync --frozen

Инструкции репозитория · Соглашения сервера · Соглашения фронтенда · Как внести изменение

Выберите проверку по характеру изменения

Подготовьте отдельный профиль PostgreSQL и PgBouncer на отдельном томе. Для тестов выделите свой проект Compose, порты, базу, очереди Redis и файловое хранилище. В готовом тестовом окружении запустите проверку фильтров метаданных в API поиска.

DJANGO_ENV=development poetry run pytest -n 0 --no-cov \
  tests/test_apps/test_main/test_api/test_document_search_filter.py

Для изменений приложения, его тестов, общих контрактов, сборки и CI запустите полный набор. Ему нужны прямое административное подключение к БД и брокер Redis.

RUNNER="poetry run" ./docker/django/ci.sh

Полный набор проверяет оба SDK и требует 100% покрытия строк и ветвей. После изменений фронтенда также выполните npm run verify из frontend/. Для отдельных изменений SDK или документации выберите проверки по правилам приёмки. Запишите команду, код завершения и точную версию для вычитки.

ContextBase0.1.0

Поиск в документации