https://github.com/michelin/suricate-widget-tester
The widget tester is an external tool of the Suricate application which allows developers to test their widgets while remaining independent from Suricate.
https://github.com/michelin/suricate-widget-tester
alerting angular developer-tools monitoring spring-boot suricate
Last synced: about 2 months ago
JSON representation
The widget tester is an external tool of the Suricate application which allows developers to test their widgets while remaining independent from Suricate.
- Host: GitHub
- URL: https://github.com/michelin/suricate-widget-tester
- Owner: michelin
- License: apache-2.0
- Created: 2021-04-21T13:18:03.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T17:31:13.000Z (about 2 years ago)
- Last Synced: 2024-05-07T18:08:05.248Z (about 2 years ago)
- Topics: alerting, angular, developer-tools, monitoring, spring-boot, suricate
- Language: Java
- Homepage:
- Size: 1.11 MB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog-builder.json
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
This project is archived and is no longer being developed or maintained.
# Suricate Widget Tester
[](https://img.shields.io/github/actions/workflow/status/michelin/suricate-widget-tester/build.yml)
[](https://github.com/michelin/suricate-widget-tester/releases)
[](https://github.com/michelin/suricate)
[](https://opensource.org/licenses/Apache-2.0)
[Download](#download) • [Install](#install) • [Suricate](https://github.com/michelin/suricate) • [Widgets](https://github.com/michelin/suricate-widgets)
Build and validate your Suricate widgets in a sandboxed setup before integrating it into a Suricate instance.
## Table of Contents
* [Download](#download)
* [Install](#install)
* [Configuration](#configuration)
* [Repository](#repository)
* [Contribution](#contribution)
## Download
You can download the Suricate Widget Tester as a JAR from the [GitHub releases page](https://github.com/michelin/suricate-widget-tester/releases) (requires Java 25).
## Install
The Suricate Widget Tester is built on the [Spring Boot framework](https://spring.io/) and can be configured using a Spring Boot
configuration file, which includes a sample file located at `src/main/resources/application.yml`.
If necessary, you can override the properties from the default `application.yml` file by following
the [Spring Boot externalized configuration guide](https://docs.spring.io/spring-boot/reference/features/external-config.html).
For example, you can create a custom `/config/application.yml` or set the `--spring.config.location` system
property when running the fat jar file:
```console
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/.
## Configuration
### Repository
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](https://github.com/michelin/suricate-widgets)).
The repository location can be configured with the following property:
```yml
application:
widgets:
repository: ''
```
It is set to `/tmp` by default.
## Contribution
We welcome contributions from the community! Before you get started, please take a look at our [contribution guide](https://github.com/michelin/suricate-widget-tester/blob/master/CONTRIBUTING.md) to learn about our guidelines and best practices. We appreciate your help in making Suricate a better tool for everyone.