Karing Manual RUS

Это руководство по настройке и использованию Karing - многофункционального proxy-клиента.
Руководство дополняется по мере выхода изменений в новых версиях программы.

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

• main.py - Основное приложение FastAPI
• templates/ - HTML-шаблоны
• static/ - Статические файлы (CSS, JavaScript, изображения)
• docs/ - Сгенерированный статический сайт для GitHub Pages

Локальный запуск

Для локального запуска приложения FastAPI выполните следующие команды:

pip install -r requirements.txt
uvicorn main:app --reload

Приложение будет доступно по адресу http://localhost:8000

Деплой на GitHub Pages

Проект настроен для автоматического деплоя на GitHub Pages через GitHub Actions. При каждом пуше в ветку master сайт автоматически пересобирается и деплоится.

Вручную можно задеплоить сайт, запустив скрипт генерации и закоммитив изменения в репозиторий.

Участие в разработке

Если вы хотите внести свой вклад в развитие проекта, пожалуйста, следуйте этим правилам:

Для контент-редакторов:

• При создании pull request используйте только папку templates/
• При добавлении скриншотов используйте ресурсы по типу https://www.iloveimg.com/ru/compress-image или другие методы сжатия изображений
• Вносите изменения исключительно в HTML-шаблоны
• Не изменяйте Python-скрипты, конфигурационные файлы и статические файлы
• Автор проекта будет отвечать за обновление остальных частей проекта после_merge ваших изменений

Для разработчиков:

• Если вы хотите внести изменения в функциональность сайта, свяжитесь с автором проекта
• Изменения в main.py и других технических файлах должны быть согласованы

Разработка

Для добавления новых страниц:

1. Создайте новый HTML-шаблон в папке templates/
2. Добавьте маршрут в main.py

Благодарности

Спасибо авторам за материал: https://telegra.ph/Karing---part1-04-06
Также использовался материал с официального руководства: https://karing.app/en/quickstart/

Лицензия

MIT