[ https://issues.apache.org/jira/browse/ARTEMIS-4680?focusedWorklogId=915358&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-915358 ]
ASF GitHub Bot logged work on ARTEMIS-4680: ------------------------------------------- Author: ASF GitHub Bot Created on: 18/Apr/24 17:23 Start Date: 18/Apr/24 17:23 Worklog Time Spent: 10m Work Description: gemmellr commented on code in PR #3: URL: https://github.com/apache/activemq-artemis-console-plugin/pull/3#discussion_r1571109296 ########## README.md: ########## @@ -1 +1,61 @@ -# activemq-artemis-console-plugin +# Apache ActiveMQ Artemis Console Plugin + + +The [Apache ActiveMQ Artemis](https://activemq.apache.org/components/artemis/) Console Plugin is written using [Hawtio v4](https://github.com/hawtio/hawtio). +The plugin is written in TypeScript. Since a Hawtio plugin is based on React and [Webpack Module Federation](https://module-federation.github.io/), +this project uses Yarn v3 and [CRACO](https://craco.js.org/) as the build tools. + +The WAR file created by this project is consumed by ActiveMQ Artemis but can be developed and run standalone. + + +### Build + +The following command first builds the `activemq-artemis-console-plugin` frontend project and then compiles and packages Review Comment: Name seems off ########## README.md: ########## @@ -1 +1,61 @@ -# activemq-artemis-console-plugin +# Apache ActiveMQ Artemis Console Plugin + + +The [Apache ActiveMQ Artemis](https://activemq.apache.org/components/artemis/) Console Plugin is written using [Hawtio v4](https://github.com/hawtio/hawtio). +The plugin is written in TypeScript. Since a Hawtio plugin is based on React and [Webpack Module Federation](https://module-federation.github.io/), +this project uses Yarn v3 and [CRACO](https://craco.js.org/) as the build tools. + +The WAR file created by this project is consumed by ActiveMQ Artemis but can be developed and run standalone. + + +### Build + +The following command first builds the `activemq-artemis-console-plugin` frontend project and then compiles and packages +the main Java project together. + +```console +mvn clean install +``` + +Building the frontend project 'artemis-console-extension' can take time, so if you build it once and make no changes on the project afterwards, you +can speed up the whole build by skipping the frontend part next time. + +```console +mvn install -Dskip.yarn +``` + +### Test run + +You can quickly run and test the console by using `jetty-maven-plugin` configured in `pom.xml`. It launches an embedded +Jetty server and deploys the plugin WAR application. From the 'artemis-console-war' directory run: + +```console +mvn jetty:run -Dskip.yarn +``` + +You can access the Artemis console with the sample plugin at: <http://localhost:8080/console/> + +## Faster plugin development + +You could run `mvn install` or `mvn jetty:run` every time to incrementally develop the `activemq-artemis-console` +frontend project while checking its behaviour in the browser. But this is not suitable for running the fast development feedback cycle. + +As shown below, a faster development cycle can be achieved by directly running the `activemq-artemis-console-plugin` Review Comment: another plugin mention ########## artemis-console-war/pom.xml: ########## @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.activemq</groupId> + <artifactId>artemis-console-project</artifactId> + <version>1.0.0-SNAPSHOT</version> + </parent> + + <groupId>org.apache.activemq</groupId> + <artifactId>artemis-console-war</artifactId> + <packaging>war</packaging> + + + <name>ActiveMQ Artemis Console War</name> + + <dependencies> + <! Issue Time Tracking ------------------- Worklog Id: (was: 915358) Time Spent: 6h 10m (was: 6h) > Upgrade the console to use HawtIO 4 > ----------------------------------- > > Key: ARTEMIS-4680 > URL: https://issues.apache.org/jira/browse/ARTEMIS-4680 > Project: ActiveMQ Artemis > Issue Type: Improvement > Components: Web Console > Reporter: Andy Taylor > Assignee: Andy Taylor > Priority: Major > Time Spent: 6h 10m > Remaining Estimate: 0h > > The current console is based upon HawtIO 1 which in turn is built on > Bootstrap. Bootstrap is old and no longer actively being maintained. > > This improvement is to migrate the current console to use HawtIO 4 which i > based on Typescript, react and Patternfly. > > A WIP can be found > [here|https://github.com/andytaylor/activemq-artemis/tree/artemis-console-ng] -- This message was sent by Atlassian Jira (v8.20.10#820010)