This repository contains the source code of the Suricate Widget Tester application.
The Suricate Widget Tester allows developers to test a widget before deploying it to a Suricate instance. It has multiple advantages:
- It is fast and easy to set up and use.
- It makes the development and testing of widgets easier and faster.
- It is fully independent of Suricate. A local Suricate instance is not required for it to work.
You can download the Suricate Widget Tester as a fat jar from the GitHub releases page.
Please note that Java 21 is required starting from version 1.1.0 (Java 8 before).
The Suricate Widget Tester is built on the Spring Boot framework and can be configured using a Spring Boot
configuration file, which includes a sample file located at src/main/resources/application.properties.
If necessary, you can override the properties from the default application.properties file by following
the Spring Boot externalized configuration guide.
For example, you can create a custom /config/application.properties or set the --spring.config.location system
property when running the fat jar file:
java -jar suricate-widget-tester.jar --spring.config.location=classpath:\,file:C:\myCustomLocation\After running the command, the application will be accessible on http://localhost:8085/.
The Suricate Widget Tester reads the content of a widget repository. The repository must follow the required structure (see the official open-source widgets GitHub repository).
The repository location can be configured with the following property:
application.widgets.repository: <path-to-repository>It is set to /tmp by default.
We welcome contributions from the community! Before you get started, please take a look at our contribution guide to learn about our guidelines and best practices. We appreciate your help in making Suricate a better tool for everyone.