Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1 KB

README.md

File metadata and controls

26 lines (20 loc) · 1 KB
Raw

Example plugin template

This is a project template to create a plugin for RODA. You can use it as a base for creating your own RODA plugin.

It includes:

  • Source code example
  • Unit testing bootstrap
  • Install dependencies and plugin properties examples
  • Build script to compile and create docker image with RODA and your plugin
  • Quick run instructions
  • README automatic generation instructions

How to build and run

To build execute ./build.sh, this will run with the latest RODA version. If you require a different RODA version, e.g. vX.X.X, update the pom.xml parent version and execute ./build.sh vX.X.X

The build script will compile the plugin and create a docker image with the base roda plus the plugin installed. To run execute (roda-plugin-template should be replaced by the project folder name):

docker run -p 8080:8080 roda-plugin-template:latest

Then open in your favorite browser http://localhost:8080.