Liferay Sample Projects

Liferay provides working examples of sample projects that target different integration points in Liferay DXP. These working examples can be copy/pasted into your own independent project so you can take advantage of various Liferay extension points. Each sample is a standalone project and includes its own build files. Liferay’s sample projects can be found in the liferay-blade-samples repository on GitHub. You can find documentation for Liferay’s sample projects in the Sample Projects reference section.

If you’d like to browse the repository locally or copy sample projects into your own project, fork and clone the liferay-blade-samples repository.

You can also use Blade CLI to create samples by running this command:

blade samples [SAMPLE_NAME]

For example, the following command generates the ds-portlet sample:

blade samples ds-portlet

At first glance, you’ll notice that the repository is broken up into three primary folders:

  • gradle
  • liferay-workspace
  • maven

The provided sample projects are organized by their development toolchains to cater to a variety of developers. Each folder offers the same set of sample Liferay projects. Their only difference is that the build files are specific to their toolchain. For example, the gradle folder contains projects using standard OSS Gradle plugins that can be added to any Gradle composite build. The same concept also applies to the liferay-workspace and maven projects.

The gradle folder also uses the Liferay Gradle plugin (e.g., com.liferay.plugin) which encompasses additional functionality for various types of Liferay projects. The Liferay Gradle plugin is recommended for Gradle users developing for Liferay DXP.

Some samples also come configured with logging to help you fully understand what the sample is accomplishing behind the scenes. For example, OSGi module logging is implemented for several samples (e.g., action-command-portlet, document-action, service-builder/jdbc, etc.), which lets OSGi modules supply their own logging configuration defaults without external configuration. See the Adjusting Module Logging tutorial for more information.

For a list of sample template projects available, visit the Liferay extension points sub-section in the Liferay Blade Samples repository. This list is not comprehensive. A subset of missing extension point samples can be found in the Liferay extension points without template projects sub-section. Visit the repo’s Contribution Guidelines section for details on contributing to this repository.

« Deploying Projects with IntelliJ IDEALiferay Upgrade Planner »
Was this article helpful?
0 out of 1 found this helpful