Broadleaf Microservices

Tutorials

Overview

The Broadleaf tutorials will give you hands on experience with our key concepts and extension patterns.

The tutorials are grouped into tutorial sets. Each tutorial set can be run in any order, see the overview and goals of each set below.

Customize Broadleaf

This tutorial provides a Basic Customer service and shows you how to extend service and domain components. The example service is not our production ready service but instead a simplified version for tutorial purposes.

Explore Common Concepts

This tutorial set starts with a Spring Boot application with no Broadleaf concepts. It incrementally adds in features. It is useful as a way to better understand some of the features you’ll find in the hundreds of out of box APIs and services and as a starting point for incorporating Broadleaf advanced features like multitenancy, workflow capabilities, and rich admin experiences to your own APIs.

Broadleaf provides full source code to our clients but you should never need to modify the Broadleaf source code. Instead, we make it easy to extend and replace components as needed. These tutorials will help you understand how that works.

Using the Broadleaf Microservices API and Making Requests to a Live Demo Instance

These tutorials will give you simple step-by-step instructions to get set up with your own demo instance of Broadleaf Microservices and make requests to it.

Customizing Tutorial Prerequisites

To work with the customization and hands on tutorials, you’ll need a few prerequisites. These are not needed for the Use APIs tutorials.

Fork / clone the BroadleafCommerce/MicroserviceTutorial project

The MicroserviceTutorial project contains all of the tutorials. Each tutorial will guide you through the right steps

Start by forking the project: (https://docs.github.com/en/github/getting-started-with-github/fork-a-repo [learn more about GitHub forks^])

From the repository main screen, choose the CODE button and select to clone or download the zip file. You can unzip or clone to any directory on your machine. In our examples, we will use the path ~/tutorials/ to represent the installation directory.

You are now are ready to start a tutorial …​

Where would you like to start?