developer-guide.md

Инструкция для начинающих

Если вы начинающий разработчик воспользуйтесь этой инструкцией. Если вы намерены изменить документацию, то эта инструкция самодостаточна, поэтому остальные пункты на этой странице вам читать не нужно.

Клонирование кода и импорт в среду разработки

Клонируйте репозиторий

git clone https://github.com/spacious-team/investbook.git

Может использоваться любая среда разработки, для простых изменений можно ограничиться текстовым редактором. Если вы используете IntelliJ IDEA, файлы настроек среды разработки уже сохранены в репозиторий, просто импортируйте код как maven проект.

Установка java

Для разработки требуется версия java, которая указана в файле pom.xml в теге <java.version>. Скачайте java под свою ОС, например с сайта OpenJDK, и установите переменные окружения JAVA_HOME и PATH, например для Windows 10 по этой инструкции.

Установка Wix

Для сборки пакета для установки Investbook требуется Wix 3. Скачать Wix 3 можно по ссылке с официального сайта Wix3 (пакет для установки расположен на GitHub). Wix в свою очередь потребует установки .NET.

На Windows вы можете установить Wix и .NET в %LOCALAPPDATA%\Programs\wix3 и %LOCALAPPDATA%\Programs\dotnet соответственно. Для этого на страницах проектов нужно скачать не msi установщики, а архивы "binaries", которые требуется распаковать в указанные папки. После этого нужно добавить следующие переменные окружения (win+R -> rundll32 sysdm.cpl,EditEnvironmentVariables):

DOTNET_ROOT=%LOCALAPPDATA%\Programs\dotnet
PATH=<предыдущие значения>;%LOCALAPPDATA%\Programs\wix3;%DOTNET_ROOT%

Компиляция

Компиляция запускается командой:

mvn clean compile

Она очищает сгенерированные ранее классы (например JAXB2), которые возможно устарели, и генерирует файл META_INF/build-info.properties, который используется приложением в своей работе.

Запуск

Перед запуском приложения средствами IntelliJ IDEA обязательна компиляция, после которой можно запустить приложение по кнопке в верхней панели.

Если у вас другая среда разработки или вы работаете из консоли, то приложение можно запустить без предварительной компиляции командой:

mvn spring-boot:run

Сборка релиза

Релиз состоит из двух файлов: zip-архива и msi-установщика. Msi-установщик собирается только на Windows. Поэтому если вы работаете под Windows, необходимо установить Wix со страницы проекта (WiX Toolset Visual Studio Extension устанавливать не нужно).

Для сборки релиза запустите

mvn package

Zip-архив может быть установлен на Linux и Mac. На Windows рекомендуется установка через msi-инсталлятор.