hahah-eto-ya-maga / counter-offensive

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Игра Контрнаступ (ContrNastup)

Браузерный 2д шутер про танки.

Оглавление

Требуемые программы

  • Docker и дополнение Docker Compose (на Windows идёт из коробки)
  • NodeJS

Запуск проекта

Все команды нужно запускать в терминале в корневой папке проекта и при запущенном Docker Desktop

Сборка (Терминал из корневой папки)

  • Сборка клиента
cd client
npm install
npm run build
cd ..
  • Сборка проекта в Docker
docker compose build

Пример сборки проекта

Запуск собранного проекта

  • Терминал
docker compose up -d

Пример запуска проекта

  • Docker Desktop Пример запуска проекта в главном меню Docker Desktop

Перезапуск проекта

  • Терминал
docker compose restart

Пример перезапуска проекта

  • Docker Desktop Пример перезапуска проекта в главном меню Docker Desktop

Остановка запущенного проекта

  • Терминал
docker compose stop

Пример остановки проекта

  • Docker Desktop Пример остановки проекта в главном меню Docker Desktop

Контейнеры

Проект содержит 5 конейтеров:

  1. database - База данных - MySQL (DB.md)
  2. api - PHP server (SERVER.md, API.md)
  3. phpmyadmin - PMA - Клиент для работы с БД
  4. web_server - Nginx

Как работать с репозиторием

  • Добавление копии репозитория на ваш ПК.
git clone https://github.com/hahah-eto-ya-maga/counter-offensive
  • Все задачи выполняются в ветке с номером задачи. Создаете ветку:
git checkout -b task_[НОМЕР-ЗАДАЧИ]_[ВАША_ЗАДАЧА]
  • После выполнения задачи, добавьте ваши файлы в отслеживаемые изменения в ветке:
git add .
  • Создайте локальную копию проекта с вашими изменениями в ветке:
git commit -m “[ОПИСАНИЕ-ВАШЕЙ-РАБОТЫ]”
  • Заберите изменения из ветки dev:
git pull origin dev
  • Вы забрали изменения с ветки dev. Возможно, появятся конфликты. Если вы исправили все конфликты, то вы слили две ветки в одну. (Важно! Когда вы войдете в режим исправления конфликтов, вы будете находиться в ветке “task_[НОМЕР-ЗАДАЧИ]| MERGING” - отсюда нельзя отправлять ваши изменения в ветку dev. Сделав то, что написано далее, вы вернетесь в ветку “task_[НОМЕР-ЗАДАЧИ]”):
git add .
git commit -m “merge with dev”
  • Отправьте вашу ветку на GitHub:
git push origin task_[НОМЕР-ЗАДАЧИ]
  • Если задача успешно протестирована - заходим на наш репозиторий. Делаем Pull Request (ПР). Перед тем, как сделать ПР - измените ветку, в которую хотите его сделать: по умолчанию будет отправление в ветку main, измените ее на ветку dev. Убедитесь, что ветка с которой вы отправляете изменения, соответствует ветке в оформлении ПР.
  • Иначе, после исправления ошибок, повторного тестирования и проверки тимлидом, заново делается локальная копия проекта и создается ПР.
  • Ошибки исправляются в исходной ветке задачи. Не забудьте в неё вернуться:
git checkout task_[НОМЕР-ЗАДАЧИ]
  • Переименование ветки:
git branch -m [СТАРОЕ_НАЗВАНИЕ_ВАШЕЙ_ВЕТКИ] [НОВОЕ_НАЗВАНИЕ_ВАШЕЙ_ВЕТКИ]

Полезные ссылки внутри проекта:

  1. Концепт проекта (CONCEPT.md)
  2. Техническое задание (TZ.md)
  3. Чек-лист (CHECK-LIST.md)

About


Languages

Language:TypeScript 60.0%Language:PHP 31.6%Language:CSS 7.9%Language:HTML 0.3%Language:Dockerfile 0.2%