Skip to content

GITHUB_PUBLISH.md

Latest commit

 

History

History
255 lines (176 loc) · 8.5 KB

GITHUB_PUBLISH.md

File metadata and controls

255 lines (176 loc) · 8.5 KB

📤 Инструкция по публикации проекта на GitHub

Шаг 1: Подготовка проекта

1.1. Убедитесь, что все важные файлы на месте

  • ✅ README.md - обновлён и готов
  • ✅ .gitignore - настроен правильно
  • ✅ LICENSE - создан
  • ✅ Все исходные файлы проекта

1.2. Удалите ненужные файлы (опционально)

Убедитесь, что в .gitignore исключены:

  • venv/ - виртуальное окружение
  • __pycache__/ - кеш Python
  • .env - файл с секретами
  • history.json - файл истории (или оставьте, если хотите)
  • desktop/build/ и desktop/dist/ - артефакты сборки

Шаг 2: Создание репозитория на GitHub

2.1. Создайте аккаунт на GitHub (если ещё нет)

Перейдите на https://github.com и зарегистрируйтесь.

2.2. Создайте новый репозиторий

  1. Нажмите кнопку "New" (или "+" → "New repository")
  2. Заполните форму:
    • Repository name: competitor-monitor (или другое имя)
    • Description: "AI-powered competitor analysis tool with web and desktop interfaces"
    • Visibility:
      • ✅ Public - если хотите открытый репозиторий
      • ✅ Private - если хотите приватный
    • ❌ НЕ ставьте галочки на "Add a README file", "Add .gitignore", "Choose a license" (у нас уже есть эти файлы)
  3. Нажмите "Create repository"

2.3. Скопируйте URL репозитория

После создания репозитория GitHub покажет инструкции. Скопируйте URL репозитория, например:

https://github.com/yourusername/competitor-monitor.git

Шаг 3: Инициализация Git в проекте

Откройте терминал (PowerShell, CMD или Git Bash) в корневой директории проекта и выполните:

3.1. Инициализация Git (если ещё не сделано)

git init

3.2. Добавление всех файлов

git add .

3.3. Первый коммит

git commit -m "Initial commit: Competitor Monitor - AI-powered analysis tool"

3.4. Переименование ветки в main (если нужно)

git branch -M main

3.5. Добавление удалённого репозитория

Замените yourusername и competitor-monitor на ваши значения:

git remote add origin https://github.com/yourusername/competitor-monitor.git

3.6. Отправка кода на GitHub

git push -u origin main

Если GitHub попросит авторизацию:

  • Для HTTPS: введите ваш GitHub username и Personal Access Token (не пароль!)
  • Для SSH: настройте SSH ключи заранее

Шаг 4: Настройка репозитория на GitHub

4.1. Добавьте описание и темы

  1. Перейдите на страницу репозитория
  2. Нажмите на иконку ⚙️ (Settings) или на кнопку "⚙️ Settings"
  3. В разделе "About" добавьте:
    • Description: "AI-powered competitor analysis tool with web and desktop interfaces"
    • Topics: добавьте теги: python, fastapi, openai, pyqt6, competitor-analysis, ai, web-scraping

4.2. Настройте README

README уже должен отображаться автоматически. Убедитесь, что:

  • Все ссылки работают
  • Скриншоты добавлены (или замените на плейсхолдеры)
  • Информация об авторе обновлена

4.3. Добавьте скриншоты (рекомендуется)

  1. Создайте скриншоты интерфейса
  2. Сохраните их в docs/screenshots/ с именами:
    • text-analysis.png
    • image-analysis.png
    • parse-site.png
    • results.png
    • history.png
    • desktop-main.png
  3. Добавьте и закоммитьте: 
    git add docs/screenshots/*.png
git commit -m "Add screenshots"
git push

Шаг 5: Дополнительные настройки (опционально)

5.1. Добавьте файл CONTRIBUTING.md

Создайте файл с правилами для контрибьюторов (опционально).

5.2. Настройте GitHub Actions (опционально)

Можно добавить автоматические тесты и проверки кода.

5.3. Добавьте Issues и Projects

Настройте систему для отслеживания багов и задач.

🔐 Безопасность перед публикацией

⚠️ ВАЖНО: Проверьте, что НЕ попало в репозиторий

# Проверьте, что .env файл не добавлен
git check-ignore .env
# Должно вернуть: .env

# Проверьте, что виртуальное окружение не добавлено
git check-ignore venv/
# Должно вернуть: venv/

Список файлов, которые НЕ должны быть в репозитории:

  • ❌ .env - файл с API ключами
  • ❌ venv/ - виртуальное окружение
  • ❌ __pycache__/ - кеш Python
  • ❌ *.pyc - скомпилированные файлы
  • ❌ history.json - личная история (опционально, можно оставить)
  • ❌ desktop/dist/ и desktop/build/ - артефайты сборки
  • ❌ Личные документы из папки documents/

📝 Быстрая команда для публикации

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

git init
git add .
git commit -m "Initial commit: Competitor Monitor"
git branch -M main
git remote add origin https://github.com/yourusername/competitor-monitor.git
git push -u origin main

🔄 Обновление проекта на GitHub

После внесения изменений:

git add .
git commit -m "Описание изменений"
git push

🆘 Решение проблем

Проблема: "fatal: not a git repository"

Решение: Выполните git init в корневой директории проекта.

Проблема: "Permission denied" при push

Решение:

  • Для HTTPS: используйте Personal Access Token вместо пароля
  • Для SSH: настройте SSH ключи

Проблема: "remote origin already exists"

Решение:

git remote remove origin
git remote add origin https://github.com/yourusername/competitor-monitor.git

Проблема: Большие файлы не загружаются

Решение:

  • Убедитесь, что большие файлы в .gitignore
  • Используйте Git LFS для больших файлов (если нужно)

✅ Чеклист перед публикацией

  • .env файл добавлен в .gitignore
  • venv/ добавлен в .gitignore
  • __pycache__/ добавлен в .gitignore
  • README.md обновлён с правильными ссылками
  • Информация об авторе обновлена в README
  • LICENSE файл создан
  • Все тестовые/личные данные удалены
  • Репозиторий создан на GitHub
  • Код загружен на GitHub
  • README отображается корректно
  • Скриншоты добавлены (опционально)

🎉 Готово!

После выполнения всех шагов ваш проект будет доступен на GitHub по адресу:

https://github.com/yourusername/competitor-monitor

Не забудьте поделиться ссылкой с другими! 🚀