Tutorials

Learn how to write a module and extend its functionality.

How to use

If you have never developed a Smartstore module before, we recommend that you read the Getting started with modules first, and then start with the Building a simple "Hello World" module tutorial. Otherwise, you can jump right into the topic you want to learn more about.

We also provide links to additional information for specific topics covered in each tutorial. This way, you can quickly brush up on that topic and jump right back in.

Example Repository

The source code for all the tutorials can be found in our Code Examples Repository.

All tutorials are included in the solution file located in the root of the repository. To run them, just follow the instructions in the ReadMe.

List of Tutorials

Building a simple "Hello World" module

Start your journey here and build your first Smartstore module.

Adding tabs

Add a tab to the product editing page in the backend.

Creating a Widget provider

Create a widget, that displays custom content in the frontend.

Adding menu items

Access the menu bar in the backend and add a menu item and a submenu.

Creating a Block

Create your own PageBuilder-Block to display in stories. Tweak the Story view modes, to provide a better user experience and render a widget.

Creating an Export provider

Provide a configurable export for products, store information, etc.

Creating a Domain entity

Create a small messaging system, using your own database table.