Skip to content

Latest commit

 

History

History
74 lines (41 loc) · 2.65 KB

README.md

File metadata and controls

74 lines (41 loc) · 2.65 KB
Raw

Demo Fragment Collections

Multiple collections of fragments for use in demos or as examples what is possible with Liferay Page Fragments.

Developed to run on the following versions of Liferay and/or Commerce: Liferay DXP 7.3 GA1, FP1, SP1, Commerce 2.1.1, etc

Built with Liferay Workspace and Blade CLI. This workspace contains the following module types: Contributed Fragment Collection, Theme Contributor

How to Build and Deploy to Liferay

Follow the steps below to build and deploy or copy the modules from the releases page to your Liferay's deploy folder.

In order to build or deploy this module you will need to install Blade CLI.

To Build

$ blade gw build

You can find the built modules at modules/{module-name}/build/libs/{module-name}.jar.

To Deploy

In gradle-local.properties add the following line to point towards the Liferay instance you want to deploy to:

liferay.workspace.home.dir=/path/to/liferay/home

$ blade gw deploy

Usage

Since these fragments are packaged as a Contributed Fragment Collection, they will automatically be available on all sites in your Liferay instance. Thus, you can start using them as you would the OOTB Liferay Fragments. You can see how to add fragments to a content page here.

Features

View Included Fragment Collection Docs

Contributors

Thanks to our current contributors:

  • @ethib137
  • @jverweijL
  • @martin-dominguez

Issues & Questions Welcome

Contributing Guidelines

Pull requests welcome.

Documentation

Fragment documentation can be auto generated using the following command:

$ python3 generateFragmentDocs.py

Releasing

Releases are handled using Github actions.

To release a new version do the following:

  1. Create a git tag.

    1. git tag v0.0.1

  2. Push the tag to Github.

    1. git push origin v0.0.1

The Github action will be triggered and will attach all assets to the release.