README.md

Market Basket SBP Sample project

A dummy project to test the SBP library.

Content

This repository contains many Maven modules:

• market.basket.sbp.sample.api which provides a set of interfaces used by the application. Each plugin provides its own implementation of these interfaces.
• market.basket.sbp.sample.application which provides the spring boot application.
• market.basket.sbp.sample.frontend.app which provides the react application.
• market.basket.sbp.sample.frontend.plugins.* which provides several plugins embedding a set of js components.
• market.basket.sbp.sample.plugins.* which provides several plugins embedding a set of specific features: controller, image resource.

How to

Build and Run

• git clone https://github.com/j-barata/marketbasket-sbp-sample.git
• cd marketbasket-sbp-sample
• mvn clean package
• java -jar application/target/market.basket.sbp.sample.application-1.0.0-SNAPSHOT-standalone.jar

The application should now be available from http://localhost:8090

Use

Through the Restful services

• List the plugins ids: GET http://localhost:8090/plugins/id
• List the plugins names: GET http://localhost:8090/plugins/list
• List the plugins resources: GET http://localhost:8090/plugins/resources
• List the plugins content: GET http://localhost:8090/plugins/basket
• Get the application specific resource: GET http://localhost:8090/logo.png
• For each plugin (example given for 'pears' plugin):
  • Call the pears specific controller: GET http://localhost:8090/pears/name
  • Get the pears specific resource: GET http://localhost:8090/pears/pear.png

Through the React application

• The web UI is locally available at http://localhost:8090.
• A demo is also available online on Heroku.

Useful links

• The SBP repository: https://github.com/hank-cp/sbp
• The Plugin Framework for Spring: https://github.com/pf4j/pf4j-spring
• A PoC of the SBP library: https://github.com/fabioformosa/sbp-pluggable-project