Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.58 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.58 KB
Raw

Build Status Sonarcloud Status

OpenCoffee Frontpage

CoffeeNet Logo

the personalisable frontpage of the CoffeeNet

The CoffeeNet Frontpage is a personalisable landingpage, which uses a plugin based mechanism for adding widgets like feeds, clock or isLieb-comic. You can write your own plugin and intregrate with the frontpage.

Requirements

  • Java 8
  • Docker 17.06.0+
  • Docker Compose 1.20.x

Development

Start application and environment (MongoDB) is used for persistence)

docker-compose up
./mvnw clean spring-boot:run

Spring Boot DevTools are also included for inflight changes.

Example Plugin Setup

All plugins from the CoffeeNet team can be found in the CoffeeNet Organisation.

Add Plugin

If you want to use a plugin you can download the jar e.g. from the Releases section. The plugin jar must be placed in /plugins-directory beside the frontpage application:

frontpage.jar
plugins/
 \-- coffeenet-frontpage-plugin-feed.jar

Build your own plugin

An CoffeeNet frontpage plugin have to implement the API. An example is the clock plugin with implementation of the frontpage plugin interface. Little more complex plugin example is the feed plugin.