[
https://issues.apache.org/jira/browse/ARTEMIS-4680?focusedWorklogId=915786&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-915786
]
ASF GitHub Bot logged work on ARTEMIS-4680:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 22/Apr/24 11:15
Start Date: 22/Apr/24 11:15
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_r1574581049
##########
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.
Review Comment:
and the other bit? `activemq-artemis-console frontend project` vs earlier
`frontend project artemis-console-extension`
Issue Time Tracking
-------------------
Worklog Id: (was: 915786)
Time Spent: 6.5h (was: 6h 20m)
> 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: 6.5h
> 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)
