An open API service indexing awesome lists of open source software.

https://github.com/blackducksoftware/blackduck-alert

Processes notifications from BlackDuck and sends them to supported distribution channels
https://github.com/blackducksoftware/blackduck-alert

integration-team sig solution

Last synced: 19 days ago
JSON representation

Processes notifications from BlackDuck and sends them to supported distribution channels

Awesome Lists containing this project

README

        

## Overview ##

This application provides the ability to send notifications from a provider to various distribution channels.

## Build ##
[![Build Status](https://travis-ci.org/blackducksoftware/blackduck-alert.svg?branch=master)](https://travis-ci.org/blackducksoftware/blackduck-alert)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

### Build Steps ###
#### Requirements ####
- JDK 17
- Node 16.15.1 (Recommended)
- NPM 8.11.0 (Recommended)

To compile the UI and create the jar file run:

```bash
./gradlew clean build
```
To build the docker images:

```bash
./gradlew dockerBuildAllImages
```
To build the zip file containing the orchestration files for deployment:

```bash
./gradlew createDeploymentZip
```

### To Run the Server Locally ###
This section describes running the server locally.

#### Run Commands ####
Execute the one of the following commands which will build the source code and then start the server:

##### Run the Server Locally #####
```bash
./gradlew runServer
```
Note: The server will be running locally over: https://localhost:8443/alert

#### UI Development with Hot Module Replacement
These commands will start a webpack dev server that can access the backend for rapid UI development.
The UI files will automatically be reloaded if there are changes through hot module replacement.

##### 1. Start the Backend Server #####
```bash
./gradlew runServer
```
Note: The server will be running locally over: https://localhost:8443/alert

##### 2. Start the webpack dev server #####
```bash
npm run start
```
Note: The webpack dev server will be running locally over: https://localhost:9000/alert

## Where can I get the latest release? ##

All releases are on the GitHub release page. https://github.com/blackducksoftware/blackduck-alert/releases

## Documentation ##
Our public documentation, including installation instructions, is located here: https://documentation.blackduck.com/bundle/alert/page/topics/general/alert-overview.html