Access to Broadleaf’s Docker Registry and Maven Nexus is needed in order to pull down the appropriate resources.

Once you have obtained these credentials, you will need to configure them for the dependencies below.

You will need Java 8 or 11 installed on your machine.

• Open JDK

• Oracle JDK

You will need to have Docker Engine & Docker Compose installed locally

Once you have docker installed, you will want to authenticate with Broadleaf’s docker registry.

Type the following into your CLI:

When prompted, type in the username and password you received above.

You’ll need to have Maven installed locally as well. Maven 3.5 or later is recommended.

Once you have maven installed, another step you need to do before you can build the project is to configure the authentication. Maven requires it to be specified in a file called settings.xml that has to be in the .m2 subdirectory in a user’s home directory.

1. Create a folder called .m2 in your home directory

2. Create a file called settings.xml in the .m2 folder

3. Copy the following contents to your ~/.m2/settings.xml making sure to replace the credentials with the ones you received above:

Now that all of the pre-requisites are installed, let’s build and run the projects!

1. First, we’ll need to download or clone this project so that we can run everything locally on your own machine. You can utilize the Clone or Download button at the top right of this page.

2. Once you have the project downloaded, let’s go ahead and build it using Maven. You’re going to navigate to the root folder (i.e. the folder that contains the main pom.xml file) of where you downloaded/un-zipped or cloned the project. In the root of this project run the following to build:

   mvn clean install

   ℹ️	It may take some time during the initial installation as the process needs to download all required dependencies. All subsequent builds should go much faster.

1. Before you start up all the APIs, you’ll need to first start up a few supporting services that are required for this example. These services are provided via docker images and can be run and started from the command line by navigating to the root of the appropriate project and running:

   docker-compose up -d && ./check-tutorial-services-status.sh

2. Next, you will want to start up the core backend commerce APIs by running the following command (instead of the simple mvn spring-boot:run command) so that you don’t have to worry about getting a valid JWT authentication token every time:

   mvn spring-boot:run -Pnosec

   ℹ️	In this project, we’ve added a maven profile called nosec which passes in some particular properties to disable certain api security measures. This allows us to easily demonstrate some example flows using the Admin and cURL (see Step 3)

3. That’s it! Once you’ve verified that the supporting services and backend APIs are running, you can visit the administration console from a browser:

   • Admin Console: https://localhost:8446

     • Username: [email protected]

     • Password: Pass1word!

   • cURL Demo:

      curl --insecure -X GET "https://localhost:8447/products?offset=0&forward=true&pageSize=50" -H "accept: application/json" -H "X-Context-Request: {\"tenantId\":\"5DF1363059675161A85F576D\",\"catalogId\":\"10\"}"