Refactoring base files
This commit is contained in:
39
README.md
Normal file
39
README.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Приложение с базовой конфигурацией для создания приложений на основе СУПП-Форм
|
||||
|
||||
Приложение содержит базовые модули СУПП, подключенные как внешние зависимости.
|
||||
Дальнейшая разработка модулей, специфичных для конкретной версии, ведётся по аналогии с СУПП-Формами.
|
||||
|
||||
Данный репозиторий предназначен для создания приложений на основе СУПП-Форм путём fork репозитория
|
||||
и последующей разработки/добавления модулей под конкретного заказчика.
|
||||
|
||||
## Базовые настройки
|
||||
|
||||
1. Выполнить fork репозитория
|
||||
2. Создать новый проект из репозитория (Project from Version Control)
|
||||
3. В модуле `backend/app` внести изменения в конфиги: `application.yaml`, `application-stage.yaml` (порты, БД и т.д.)
|
||||
4. В корневом POM-файле, см. [pom.xml](pom.xml), указать версию:
|
||||
```xml
|
||||
<version>1.0.0-Company</version>
|
||||
```
|
||||
Эту же версию указать в дочерних POM (backend, app) в секции parent, чтобы версии новых модулей были согласованы.
|
||||
5. Указать базовую версию СУПП в POM backend модуля, раздел properties
|
||||
см. файл [pom.xml](backend/pom.xml) строка 45
|
||||
```xml
|
||||
<supp-base.version>1.0.0</supp-base.version>
|
||||
```
|
||||
Настройка подключаемых (готовых) модулей может осуществляться более точечно, через указание конкретных версий для каждого модуля.
|
||||
6. Указать версии frontend-модулей в корневом package.json
|
||||
7. После настройки необходимо попробовать собрать и запустить приложение. Удостовериться что базовые настройки не вызывают конфликта
|
||||
и приложения работает как ожидается.
|
||||
8.
|
||||
После выполнения этих пунктов можно продолжать добавление/разработку новых модулей.
|
||||
|
||||
### PS
|
||||
Для удобства в проекте оставлены **TODO** комментарии для быстрого поиска необходимых мест настройки
|
||||
|
||||
## Добавление новых модулей
|
||||
|
||||
Модули в данное приложение могут добавляться 2-мя способами:
|
||||
1. Через подключение уже существующих версий модулей, совместимых с текущей версией базовых модулей
|
||||
2. Через добавление новых модулей в приложение (модули добавляются аналогично тому, как это описано в документации базового
|
||||
репозитория СУПП-Формы)
|
||||
Reference in New Issue
Block a user