Before you can build this project, you must install and configure the following dependencies on your machine:
- Node.js: We use Node to run a development web server and build the project.
Depending on your system, you can install Node either from source, as a pre-packaged bundle or using the n tool. We require node
- Yarn: We use Yarn to manage Node dependencies. Depending on your system, you can install Yarn either from source or as a pre-packaged bundle.
After installing Node, you should be able to run the following command to install development tools. You will only need to run this command when dependencies change in package.json.
We use yarn scripts and Webpack as our build system.
Run the following commands in three separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.
./mvnw make local-services yarn start
specifying a newer version in package.json. You can also run
yarn update and
yarn install to manage dependencies.
help flag on any command to see how you can use it. For example,
yarn help update.
yarn run command will list all of the scripts available to run for this project.
OAuth 2.0 / OpenID Connect
To log in to your app, you'll need to have Keycloak up and running. For local development you can run it with
docker-compose -f src/main/docker/keycloak.yml up
The former command starts also the local instance of infinispan.
The security settings in
src/main/resources/application.yml are configured for this image.
Building for production
To optimize the equoid application for production, run:
./mvnw -Pprod clean package
index.html so it references these new files.
To ensure everything worked, run:
java -jar target/*.war
Then navigate to http://localhost:8080 in your browser.
You can deploy the application into local OpenShift cloud by invoking
This will kill all the running Docker containers, starts the local OpenShift cloud and creates the resources representing deployment configs, services, routes, secretes, etc. It assumes the
docker command can be run w/o root privileges and also the
oc command on the
For deploying to an external OpenShift cluster run:
or if you don't need Prometheus, Alert manager and Grafana combo, simply:
To launch your application's tests, run:
./mvnw clean test