Перейти к основному содержимому
Версия: 15.x

Разработка

В этом документе объясняется, как вносить и запускать собственные изменения.

Создание ответвления (fork) кода на вашем компьютере​

GitHub значительно упрощает разработчикам создание собственной версии официальных исходных кодов UMS для добавления своих доработок или функций. GitHub также упрощает отправку этих функций официальной команде разработчиков UMS в виде «Pull Request».

Теперь у вас есть новый репозиторий на локальном компьютере.

Разработка с помощью IDE​

VS Code​

Это наш рекомендуемый редактор, поскольку он отлично работает как с Java, так и с TypeScript, нашими двумя основными языками.

Сервер Java​

Когда вы откроете код, вы, вероятно, увидите рекомендации по установке расширений, например, Extension Pack for Java. Установите его/их. Когда расширения установлены и настроены, вы можете запустить сервер Java, нажав в верхней части Run -> Start Debugging, и перезагрузить его с помощью Run -> Restart Debugging. Эти команды должны выполняться в течение 1 секунды, обеспечивая быстрый цикл разработки.

Веб-интерфейсы браузера​

Если вы хотите внести изменения в наши веб-интерфейсы браузера, вам также потребуется запустить сервер React, который будет заниматься компиляцией и обслуживанием кода TypeScript.

В VS Code вы можете перейти в Command Palette и выбрать Debug: Select and Start Debugging, затем выберите Launch web interface. Он автоматически перезагрузится при любых изменениях, которые вы вносите в файлы React.

Для ручного рабочего процесса вы можете перейти в папку react-client и выполнить yarn для загрузки необходимых зависимостей. Затем просто запустите yarn dev, что должно открыть веб-плеер в браузере и автоматически компилировать любые изменения кода.

Для веб-интерфейса настроек вы можете открыть react-client/package.json и изменить порт прокси с 9002 на 9001. Теперь yarn dev должен обслуживать веб-настройки вместо веб-плеера.

Eclipse​

  • Установите плагин m2e Eclipse (http://eclipse.org/m2e/)

  • Установите плагин EGit Eclipse (http://eclipse.org/egit/)

  • В Eclipse выберите меню «Window > Show View > Git Repositories». Затем выберите "Window > Navigation > Show View Menu", выберите "Add a Repository". Перейдите в каталог, где вы клонировали свой репозиторий, и нажмите кнопку «Search». Выберите ваш форкнутый репозиторий и нажмите "OK". Репозиторий должен появиться в окне Git Repositories.

  • Нажмите ПКМ на репозиторий и выберите в меню «Import Maven Projects». Выберите проект «/pom.xml» и нажмите «Finish».

    Примечание: если проект с таким же именем уже существует, нажмите «Advanced» и установите «Name template» как [artifactId]-YOURNAME (замените YOURNAME на имя пользователя GitHub). Затем нажмите "Finish".

Теперь вы видите исходники в Eclipse, но проекту всё ещё не хватает «Git» составляющей. Другими словами, он еще не привязан к локальному репозиторию. Это означает, что вы пока не можете выполнять какие-либо действия Git из Eclipse. Добавьте недостающую связь, опубликовав проект:

  • Нажмите ПКМ на только что созданный проект и выберите меню «Team > Share Project...». Выберите "Git" и нажмите "Next >". Установите флажок «Use or create repository in parent folder of project» и убедитесь, что проект выбран. Затем нажмите "Finish".

Убедитесь, что ваш проект теперь находится под управлением Git. Нажмите ПКМ на проект, и в разделе «Team» вы увидите все опции для работы с Git.

Вы можете собрать UMS из Eclipse:

  • Создайте новую конфигурацию запуска в «Run > Run Configurations...», нажмите ПКМ на «Maven Build», выберите «New», Name: Build UMS, Goals: package. Выберите вкладку «JRE» и добавьте следующие аргументы VM: -Xmx1500m -XX:MaxPermSize=256m. Наконец нажмите кнопку "Apply".

Во время разработки вам нужно будет запускать UMS из Eclipse. Вот как это сделать:

  • Создайте новую конфигурацию запуска в «Run > Run Configurations...», нажмите ПКМ на «Maven Build», выберите «New», Name: Run UMS, Base directory: ${project_loc}, Goals: test, Profiles: run-from-eclipse. Выберите вкладку «JRE» и добавьте аргументы VM: -Xmx1500m -XX:MaxPermSize=256m. Наконец нажмите кнопку "Apply".

Теперь вы готовы начать разработку!

Когда вы будете довольны своими изменениями, вы можете зафиксировать их в локальном репозитории из Eclipse, нажав ПКМ и выбрав «Team > Commit...».

Когда вы удовлетворены своими коммитами и хотите опубликовать их в своём репозитории на GitHub, нажмите правой кнопкой мыши на проект и выберите «Team > Push to Upstream».

Возврат ваших изменений в основной проект​

Если вы хотите внести вклад в проект UMS, вы можете отправить «Pull Request» команде разработчиков. См. Создание запроса на слияние для получения более подробной информации.