JarCastingTrying out MTA Web Console
If you just want to run MTA Web Console, not build or modify it, the simplest way is to use the docker image at https://hub.docker.com/r/windup3/windup-web_nightly/.
If you want to build MTA Web Console yourself and run it without setting up a WildFly server and Keycloak, you can build windup-web-distribution after building windup-web to create a self-contained distribution.
Setting up the development environment
Requirements
- JDK 8
- Maven 3.2.5+ (3.3.x recommended)
Environment setup
-
Set your local Maven
setting.xmlby copying filesettings.xmlfrom checked out sources into$HOME/.m2/or use it directly while calling maven with option-s settings.xml -
Install NodeJS Package Manager (npm)
- Debian/Ubuntu:
sudo apt-get install npm - RHEL 7: 1) Install EPEL 2)
sudo yum install npm - Fedora:
sudo dnf install npm
NOTE: If npm is version is less than 3.8.8, try the following to force an update:
sudo npm install -g npm - Debian/Ubuntu:
-
Note: Check that your installed version of yarn is at least v0.22.0 (yarn --version)
-
sudo npm install -g bower- If you run into problems with permissions (typically EACCES error), use this guide to fix it.
npm installcommand should be replaceable withyarn add.- For global packages, use
sudo yarn global add. Yarn should be faster, but if there is any problem with it, use NPM. Here is nice comparison of npm and yarn commands.
-
Get current version of phantomjs
if phantomjs is not installed yet, run
sudo npm install -g phantomjs-prebuiltOr
sudo npm install -g phantomjs-prebuilt --unsafe-permelse run
sudo npm update -g phantomjs-prebuilt -
For development purpose and regular redeployment, raise the Metaspace limit. In
wildfly-10.1.0.Final/bin/standalone.conf, change theMaxMetaspaceSizevalue to 2048:JAVA_OPTS="-Xms64m -Xmx512m -XX:MetaspaceSize=96M -XX:MaxMetaspaceSize=2048m -Djava.net.preferIPv4Stack=true"
Building the Windup project
To build Windup, you need to clone and build several git repositories:
If you want to contribute to Windup development, here is a script which clones the repositories, adds the upstream and sets up the remote tracking branches. First, you'll need to fork all the repositories to your user account. Then, change your GitHub.com user name in the script below.
GITHUB_USER="OndraZizka"
BASEDIR=$(pwd)
for i in \
windup \
windup-rulesets \
windup-quickstarts \
windup-distribution \
maven-indexer \
windup-maven-plugin \
; do
cd $BASEDIR
git clone [email protected]:$GITHUB_USER/$i.git
cd $i
git remote add upstream https://github.com/windup/$i.git
git fetch upstream
git branch --set-upstream-to=upstream/master
git pull
mvn clean install -DskipTests
done
cd $BASEDIR
# Install NodeJS 6+
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
# Install NPM
sudo apt-get install npm
sudo npm install -g npm
#sudo apt install yarn
sudo npm install -g yarn
sudo npm install -g bower
sudo npm install -g phantomjs-prebuilt
## Then fix NPM permissions, basically by downloading and installing it just for one user…
## https://docs.npmjs.com/getting-started/fixing-npm-permissions
BASEDIR=$(pwd)
for i in \
windup-keycloak-tool \
windup-web \
windup-web-distribution \
; do
cd $BASEDIR
git clone [email protected]:$GITHUB_USER/$i.git
cd $i
git remote add upstream https://github.com/windup/$i.git
git fetch upstream
git branch --set-upstream-to=upstream/master
git pull
mvn clean install -DskipTests
done
cd $BASEDIR
Running the webapp
-
Build:
mvn clean install -DskipTests -
Wildfly/EAP 7 must be run with
-c standalone-full.xmlas Messaging subsystem is required. -
Execute the CLI script at: scripts/eap-setup.cli on Wildfly/EAP 7
bin/jboss-cli.sh -c --file=scripts/eap-setup.cli -
Deploy the exploded
services/target/mta-web/apiandui/target/mta-webto EAP 7.There are 3 possible ways how to do it.
-
Manual copying:
cp -r services/target/mta-web/api ~/apps/wildfly-10.1.0.Final/standalone/deployments/mta-web/api.war; touch ~/apps/wildfly-10.1.0.Final/standalone/deployments/rmaht-web/api.war.dodeploy; cp -r ui/target/mta-web ~/apps/wildfly-10.1.0.Final/standalone/deployments/mta-web.war; touch ~/apps/wildfly-10.1.0.Final/standalone/deployments/mta-web.war.dodeploy;or
-
JBoss CLI deployment, deploy the
targetdirectory directly - see WildFly docs:deploy services/target/mta-web/api --unmanaged; deploy ui/target/mta-web --unmanaged;or
-
Editing profile configuration and adding the following block to
standalone-full.xmlunder<server>, at the end of the file:<deployments> <deployment name="mta-web/api" runtime-name="api.war"> <fs-exploded path=".../windup-web/services/target/mta-web/api"/> </deployment> <deployment name="mta-web" runtime-name="mta-web.war"> <fs-exploded path=".../windup-web/ui/target/mta-web"/> </deployment> </deployments>
Note: Replace ... with real absolute path on your local environment.
-
-
Follow the steps for deploying keycloak in Keycloak Setup
-
Access the webapp: http://localhost:8080/mta-web
Deploy your changes while coding
- Follow the previous step (use the 3rd way of running the webapp: edit
standalone-full.xml) - Install webpack:
sudo npm install --global [email protected]. You can also install webpack-cli instead of webpack:sudo npm install --global [email protected] - Move to webapp folder:
cd windup-web/ui/src/main/webapp - Execute
webpack -worwebpack-cli -w
Adding Swagging Core
Swagger Core is an open source Java implementation of Swagger/OpenAPI.
It resolves JAX-RS annotated resources and Java annotated POJOs into OpenAPI schemas, handles serialization/deserialization and provides an integration mechanism.
To get the OpenAPI specifications file, you can compile this project enabling the swagger profile:
- from
windup-web/servicesfolder execute the commandmvn clean compile -Pswagger - in
windup-web/services/target/swaggerfolder you'll findopenapi.jsonandopenapi.yamlfiles with the OpenAPI specifications
If you want to create a MTA Web application that provides the openapi.json and openapi.yaml files at runtime:
- build this project enabling the
swaggerprofile, executing -fromwindup-webfolder- themvn -DskipTests clean install -Pswaggercommand - the files will be available at http://localhost:8080/mta-web/api/openapi.json and http://localhost:8080/mta-web/api/openapi.yaml
