Перейти к содержимому

Руководство по разработке

Настройка среды разработки

  1. Требования:

    • Go 1.20 или новее
    • Git
    • Make (опционально, для использования Makefile)
  2. Клонирование репозитория:

Окно терминала
git clone https://github.com/kutovoys/xray-checker.git
cd xray-checker
  1. Установка зависимостей:
Окно терминала
go mod download
  1. Сборка проекта:
Окно терминала
make build
# или
go build -o xray-checker

Структура проекта

.
├── checker/ # Логика проверки прокси
├── config/ # Обработка конфигурации
├── metrics/ # Метрики Prometheus
├── models/ # Модели данных
├── parser/ # Парсер подписок
├── runner/ # Запуск процессов Xray
├── subscription/ # Управление подписками
├── web/ # Веб-интерфейс
├── xray/ # Интеграция с Xray
├── go.mod # Файл модулей Go
└── main.go # Точка входа в приложение

Внесение изменений

  1. Создайте новую ветку:
Окно терминала
git checkout -b feature/ваше-название-функции
  1. Внесите изменения
  2. Запустите тесты
  3. Обновите документацию при необходимости
  4. Отправьте pull request

Локальное тестирование

  1. Настройте тестовую конфигурацию:
Окно терминала
export SUBSCRIPTION_URL="ваша_тестовая_подписка"
  1. Запустите в режиме разработки:
Окно терминала
go run main.go
  1. Запустите с определенными функциями:
Окно терминала
go run main.go --proxy-check-method=status --metrics-protected=true