Development Setup Overview
Step 1 of 1
Liferay’s development tools aim to help you get started fast. The basic steps for installing Liferay IDE are
Download a Liferay IDE bundle.
Unzip the downloaded package to a location on your system.
You’ll follow these steps, and then generate an environment for developing your first Liferay Portal application.
Installing a Liferay IDE Bundle
To install Liferay IDE, follow these steps:
Download and install the Java Development Kit (JDK). Liferay Portal runs on Java. The JDK is required because you’ll be developing Liferay Portal apps in Liferay IDE. The JDK is an enhanced version of the Java Environment used for developing new Java technology.
Download Liferay IDE. Installing it is easy: unzip it to a convenient location on your system.
To run Liferay IDE, execute the
The first time you start Liferay IDE, it prompts you to select an Eclipse workspace. If you specify a folder where no workspace currently exists, Liferay IDE creates a new workspace in that folder. Follow these steps to create a new workspace:
When prompted, indicate your workspace’s path. Name your new workspace
guestbook-workspaceand click OK.
When Liferay IDE first launches, it presents a welcome page. Click the Workbench icon to continue.
Nice job! Your development environment is installed and your workspace is set up.
Creating a Liferay Workspace
Now you’ll create another kind of workspace–a Liferay Workspace. By holding and managing your Liferay Portal projects, a Liferay Workspace provides a simplified, straightforward way to develop Liferay Portal applications. In the background, a Liferay Workspace uses Blade CLI and Gradle to manage dependencies and organize your build environment. Note that to avoid configuration issues, you can only create one Liferay Workspace for each Eclipse Workspace.
Follow these steps to create a Liferay Workspace in Liferay IDE:
Select File → New → Liferay Workspace Project. Note: you may have to select File → New → Other, then choose Liferay Workspace Project in the Liferay category.
A New Liferay Workspace dialog appears, which presents several configuration options.
Give your workspace the name
Next, choose your workspace’s location. Leave the default setting checked. This places your Liferay Workspace inside your Eclipse workspace.
Check the Download Liferay bundle checkbox to automatically download and unzip a Liferay Portal instance in your workspace. When prompted, name the server
Click Finish to create your Liferay Workspace. This may take a while because Liferay IDE downloads the Liferay Portal bundle in the background.
A dialog appears prompting you to open the Liferay Workspace perspective. Click Yes, and your perspective switches to Liferay Workspace.
Congratulations! Your development environment is ready! Next, you’ll get started developing your first Liferay Portal application.