Вклад в проект

Стандарты кода

Соглашения

API-дизайн

Для сценариев, требующих взаимодействия с серверной частью, API серверной части должен соответствовать маршрутам на стороне клиента. Если на одной странице есть несколько сетевых запросов, их следует разделить по древовидной структуре, например: Monitor > Topic модуль

Маршрут на стороне клиента: /#monitor/topic
API:
- Получить все темы /monitor/topic

Monitor > Alert модуль

Маршрут на стороне клиента: /#monitor/alert
API:
- Получить все оповещения /monitor/alert
- Добавить оповещение /monitor/alert/add

Стандарты для клиентской стороны

• Используйте символ перевода строки (LF) для переноса строк.
• Обязательно установите ESLint для проверки стандартов кода.
• Если компонент можно использовать совместно, его необходимо преобразовать в общий компонент.

Стандарты серверного кода

Используйте ограничения, установленные в руководстве по стандартам кодирования Alibaba Java.

Разработка клиентской части

Рекомендуется использовать VS Code для разработки клиентской части. Проект на клиентской стороне зависит от серверных служб. Вы можете запустить серверные службы заранее или изменить proxyConfig в package.json, указав доступный адрес серверной службы. Подробнее см. в KCenter-Frontend/README.md.

Установка Node

Пропустите этот шаг.

Запуск

$ cd KafkaCenter/KafkaCenter-Frontend
$ npm install
$ npm start

Сборка и публикация

$ cd KafkaCenter/KafkaCenter-Frontend
$ npm run build

После компиляции код будет опубликован в папке ../KafkaCenter-Core/src/main/resources/static.

Разработка серверной части

Установите JDK 11 и Maven 3.5+

Пропустите этот шаг.

Компиляция и запуск

$ cd KafkaCenter
$ mvn clean package -Dmaven.test.skip=true
$ cd KafkaCenter\KafkaCenter-Core\target
$ java -jar KafkaCenter-Core-0.0.1-SNAPSHOT.jar

Публикация

$ cd KafkaCenter
$ mvn clean package -Dmaven.test.skip=true