Home/Resources/Liferay Masterclass prerequisites

Workshop

Liferay Masterclass prerequisites

Six steps to get your computer, tools and accounts ready before the workshop. Tick each item as you go: your progress is saved in this browser.

Prepare your computer

Install and check each item below. Do this before you travel, so you don't depend on the venue's Wi-Fi. Run the commands in a terminal: the Terminal app on a Mac or Linux, or Command Prompt or PowerShell on Windows.

Based on Liferay's classroom training prerequisites.

  • Any recent version. You don't need a GitHub account for this part.

    How to install

    Windows

    Install Git for Windows from git-scm.com, or run the command below. During setup, choose to use Git from the command line and also from third-party software.

    winget install --id Git.Git -e

    macOS

    Run the command below and click Install when macOS asks. With Homebrew, you can run brew install git instead.

    xcode-select --install

    Linux

    On Ubuntu or Debian:

    sudo apt install git

    Check it

    git version

    You should see something like:

    git version 2.44.0
  • A JDK, not just a JRE, reporting a 21.x version.

    How to install

    Windows

    Install Microsoft Build of OpenJDK 21:

    winget install Microsoft.OpenJDK.21

    macOS

    With Homebrew:

    brew install --cask microsoft-openjdk@21

    Linux

    On Ubuntu or Debian:

    sudo apt install openjdk-21-jdk

    Prefer a ZIP or TAR.GZ? Download OpenJDK 21 from Microsoft, extract it to a folder of your choice and set the JAVA_HOME environment variable to that folder. Open a new terminal afterwards. If java -version shows another version, set JAVA_HOME to your JDK 21 folder and put its bin folder first in your PATH.

    Check it

    java -version
    javac -version

    You should see something like:

    openjdk version "21.0.5" 2024-10-15 LTS
    OpenJDK Runtime Environment Microsoft-10377968 (build 21.0.5+11-LTS)
    OpenJDK 64-Bit Server VM Microsoft-10377968 (build 21.0.5+11-LTS, mixed mode, sharing)
    javac 21.0.5
  • Version 7.0 or later, which Liferay DXP needs to work with JDK 21. Install the JDK first.

    How to install

    macOS and Linux

    Run the command below. When it says Blade installed successfully, open a new terminal. If blade isn't found, add the folder the installer shows to your PATH.

    curl -L https://raw.githubusercontent.com/liferay/liferay-blade-cli/master/cli/installers/local | sh

    Windows

    Download and run the Liferay Project SDK installer: it detects your Java and adds blade to your PATH. If you use Git Bash, you can run the macOS and Linux command instead.

    If your version is older than 7.0, update it:

    blade update

    Check it

    blade version

    You should see something like:

    blade version 7.0.3
  • Enough to run Liferay DXP on your computer during the workshop. Close other heavy applications on the day.

  • Working through the matching Liferay Learn Learning Path first lets the workshop move faster and go deeper.

Install your tools

You'll work in your Liferay Workspace in VS Code, with an AI assistant at your side. Install VS Code, then the AI assistant you have access to: one is enough, and ticking it completes this step.

Create your accounts

Sign up with the email address you registered for the workshop with.

  • AI Hub and LDP both need to reach your Liferay DXP instance on a public URL, and ngrok provides it. Create an account with your email address so we can add you to our Liferay Enablement ngrok account.

  • You'll need it to download new product license files for CMP/DSR.

Accept your invitations

You should receive these invitations before the workshop. Accept each one when it arrives, and check your spam folder if one is missing.

  • An invitation to join AI Hub for the training.

  • An invitation to join an LDP workspace for the training.

  • An invitation to the repository with the workbook you'll be testing and its context source materials. Until you accept it, the link shows "Page not found". Once you've accepted, clone it:

    git clone https://github.com/liferay/liferay-course-masterclass.git

Open the workbook

The workbook is the step-by-step guide you'll follow during the workshop.

  • It's in the workshop repository, at context-source/liferay-skills-learning-path.html. Open it from your clone, or on GitHub once you have access.

Check everything with your AI assistant

Let the AI assistant you installed in step 2 check your setup for you. It runs the checks in a terminal and tells you what passes and what to fix.

  1. In VS Code, open the folder with your clone of the workshop repository (File → Open Folder).
  2. Open your AI assistant's chat:
    • Claude Code: click the Claude icon, or run Claude Code: Open from the Command Palette.
    • OpenAI Codex: click the Codex icon in the sidebar.
    • GitHub Copilot: open the Chat view and switch the mode to Agent, so Copilot can run commands.
  3. Copy the prompt below, paste it into the chat and send it. When the assistant asks to run a command, allow it: the checks only read information.
Prompt
Check that my computer is ready for the Liferay Masterclass. Run each check in the terminal, one at a time. Don't install or change anything.

1. Git: run `git version`. PASS if Git is installed.
2. Java: run `java -version` and `javac -version`. PASS if both report version 21.x (a JDK, not just a JRE).
3. Blade: run `blade version`. PASS if it's 7.0 or later.
4. Memory: check the free RAM. PASS if at least 4 GB is available.
5. Disk: check the free space on the drive with my home folder. PASS if at least 10 GB is free.
6. Workshop repository: find my clone of github.com/liferay/liferay-course-masterclass (in the open folder or my home folder). PASS if it exists and contains context-source/liferay-skills-learning-path.html.
7. ngrok: run `ngrok version` and `ngrok config check`. PASS if ngrok is installed and has an auth token; otherwise WARN.

Then show the results as a table with the columns Check, Result (PASS, WARN or FAIL) and Details. For anything that isn't PASS, tell me how to fix it.

Finally, list what I need to confirm myself, because you can't check it: my Liferay Marketplace account, and my AI Hub, LDP workspace and GitHub invitations.
Example: the AI assistant's chat in VS Code shows a table where Git, Java, Blade, memory, disk, the workshop repository and ngrok all show PASS, followed by the accounts and invitations to confirm yourself.
Example of the result when everything is ready. The wording, versions and layout differ by assistant and computer.
  • Run the check below, fix anything marked FAIL or WARN, and run it again until everything passes. Then confirm the accounts and invitations it lists.

Something not working, or an invitation hasn't arrived? Contact the workshop organizers, or see Get help.