https://github.com/springwolf/springwolf-ui

Web UI for Springwolf
https://github.com/springwolf/springwolf-ui

asyncapi spring-boot springwolf

Last synced: 3 months ago
JSON representation

Web UI for Springwolf

• Host: GitHub
• URL: https://github.com/springwolf/springwolf-ui
• Owner: springwolf
• License: apache-2.0
• Archived: true
• Created: 2020-08-11T08:23:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-27T14:45:35.000Z (over 1 year ago)
• Last Synced: 2024-07-29T16:59:27.461Z (6 months ago)
• Topics: asyncapi, spring-boot, springwolf
• Language: TypeScript
• Homepage:
• Size: 6.64 MB
• Stars: 5
• Watchers: 3
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#  Springwolf UI

##### Web UI for Springwolf

![version](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-ui?color=green&label=release&style=plastic)

![springwolf-ui](https://github.com/springwolf/springwolf-ui/workflows/springwolf-ui/badge.svg)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

## Usage

Add the following dependencies:

```groovy

dependencies {

    runtimeOnly 'io.github.springwolf:springwolf-ui:0.7.0'

}

```

After starting the application, visit: `localhost:8080/springwolf/asyncapi-ui.html`.

## Development

1. Run `npm i`

2. Run `ng serve`

### Mock Data

The application renders content based on mock data in `src/app/shared/mock`.

It contains multiple mocks - including the ones from the springwolf-core examples projects.

To update the mock data, run `npm run update-mocks`.

## Release

Releasing is done by running the gradle task `publish`. For local development, use `publishToMavenLocal`.

### Setup the signing keys

If you do not have gpg keys yet, generate one with: `gpg --full-gen-key` You will need to set password.

Use the following environment variables:

- ORG_GRADLE_PROJECT_SIGNINGKEY: Output of `gpg --armor --export-secret-key`

- ORG_GRADLE_PROJECT_SIGNINGPASSWORD: Password for the gpg key