Generating Project Samples with Blade CLI

Liferay provides many useful sample projects for those interested in learning best practices for Liferay DXP projects. You can learn more about these samples by visiting Sample Projects.

Rather than cloning the repository, you can generate these samples using Blade CLI for convenience.

1. List the available sample projects:

   blade samples
   

   Note the sample project you want to generate; you’ll use it in the next step.

2. Run the following command to generate a sample project:

   blade samples <NAME>
   

   For example, to generate the portlet-ds sample, execute

   blade samples ds-portlet
   

   The sample is generated in the current folder.

Note: Interested in generating legacy versions of Blade samples? Pass in the -v param followed by the Liferay DXP version to target. For example,

blade samples -v 7.0 ds-portlet

Awesome! You’ve successfully generated a Liferay sample project using Blade CLI!