Getting Started With Developer Studio

With the purchase of a subscription to Liferay Digital Experience Platform (DXP), customers have access to Liferay Developer Studio, which  is a set of Eclipse plugins designed to ease development with Liferay DXP. 

This article documents the features included with Liferay Developer Studio and the steps for intallation, as well as instructions for how to create a Workplace and a portlet with Plugins SDK.

Included Features

Liferay Developer Studio 3.3.0-GA1

• Eclipse Oxygen
• Liferay IDE 3.3.1-ga2
• JPM
• BLADE
• Liferay Workspace
• Liferay DXP 7.1 

Steps for Installation

1. Download the bundle.
2. Run the installer for your platform.
3. Select your Java runtime.
4. Select the directory to install Developer Studio. 
5. Choose if you would like to install Developer Studio only.

   If choosing this option, steps 6-10 will be skipped.

6. Add your liferay.com email address and password.
7. Browse your activation key.
8. Select if you would like to to config a proxy or not (Note: The proxy settings will be saved in .gradle/gradle.properties file under your home folder).
9. Finish the installation.
10. Once it is finished the following will be installed.
    1. Blade CLI (installed into your system path)
    2. Liferay Workspace initialized directory (under $install_dir/liferay-workspace)
    3. Developer Studio application

Resolution

Creating a Liferay Workspace With Developer Studio

1. Click File > New > Liferay Workspace Project
   1. Workspace Name: LiferayWorkspace
   2. Check the Download Liferay Bundle box.
   3. Click Finish.
2. Once the process is completed, there is a bundles folder inside the Liferay Workspace folder where the projects can be deployed.

   Note: There will be a popup dialog prompting users to switch to Liferay Workspace if the current perspective is different.

3. Create a module project. Go to File > New > Liferay Module Project
   1. Project name: testModuleInLS
   2. Select a project template: (mvcportlet is the default).
   3. Click Next.
4. Enter the following:
   1. Component Class Name: Testmoduleinlsmvcportlet
   2. Package Name: com.example
5. Add the following properties:
   1. Click Add Property Key 
   2. Input a property name and value 
   3. Click Finish
6. Check the modules
   1. There is a modules folder inside the Workspace folder where all modules are located.
7. Project deployment
   1. To deploy the project, click on the root of the project and drag it from the project explorer onto the Liferay runtime environment in the server view. Look for the following:

      STARTED testmoduleinls_1.0.0

Creating Portlets With Plugins SDK

Portlet creation using the Plugins SDK is simple. There is a portlets folder inside the Plugins SDK folder where the portlet projects reside. The first thing to do is give a project name (without spaces) and a display name (which can have spaces).Once portlet has been name, begin creating the project using Developer Studio.

In Developer Studio:

1. Go to File > New... > Liferay Plugin Project
   1. Project name: my-hell0-world
   2. Display name: My Hello World
   3. Select the Build Type (plugins-sdk)
   4. Select the plug-in type (portlet is default)
   5. Click Next
2. Choose a framework for the project.
   1. Click Finish
   2. Additional Step!

      If you did not import the SDK location, please click next and import it. Then click Finish.