[
https://issues.apache.org/jira/browse/ARTEMIS-4680?focusedWorklogId=917105&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-917105
]
ASF GitHub Bot logged work on ARTEMIS-4680:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 01/May/24 06:47
Start Date: 01/May/24 06:47
Worklog Time Spent: 10m
Work Description: andytaylor commented on code in PR #2:
URL:
https://github.com/apache/activemq-artemis-console/pull/2#discussion_r1585945246
##########
README.md:
##########
@@ -1 +1,62 @@
-# activemq-artemis-console
+# Apache ActiveMQ Artemis Console
+
+
+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 `artemis-console-extension` frontend
project and then compiles and packages
+the main Java project Web Archive in `artemis-console-war`.
+
+```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
+cd artemis-console-war
+mvn jetty:run -Dskip.yarn
+```
+
+You can access the Artemis console with the sample plugin at:
<http://localhost:8080/console/>
Review Comment:
Ive added some docs explaining how to use.
Issue Time Tracking
-------------------
Worklog Id: (was: 917105)
Time Spent: 8h 40m (was: 8.5h)
> 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: 8h 40m
> 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)
