Liferay IDE is a collection of Eclipse plugins created by Liferay, Inc. to support developing plugins, e.g. portlets, hooks, themes, etc, for the Liferay Portal platform.
To get started, check out the project's community homepage at http://www.liferay.com/community/liferay-projects/liferay-ide
To install the Liferay IDE plugins into your Eclipse install using either the stable or milestone updatesite:
- Latest stable release (2.2.x): http://releases.liferay.com/tools/ide/stable/
- Latest milestone release towards 3.0: http://releases.liferay.com/tools/ide/latest/milestone/
- Additional downloads available here: https://www.liferay.com/downloads/liferay-projects/liferay-ide
To get up and running quickly, download a pre-built Liferay IDE release and install it into your Eclipse install. Follow the Installation Guide for instructions. Then use the Getting Started Tutorial for how to create and deploy a Liferay Project using Liferay IDE.
Building from source
If you would like to build from source, use this following command:
$ mvn clean verify -DskipTests
Once it finishes the locally built Eclipse updatesite will be located here:
You can install this using Help > Install New Software... > Add > Archive > Point to newly built zip file
Debug a fix? Send a pull request?
If you want to help submit a bug fix or just step through the code to see what we are doing wrong :) you are going to need to import the source and launch a test eclipse with your fix and then step through the code. Here is the process you can follow
- Download Eclipse for Committers package
- Run this eclipse with 2048M memory setting (set -Xmx2048m in eclipse.ini)
- Install the latest Liferay IDE CI build
- Use this updatesite url.
- Install all features
- Clone this repo
- Import all projects into Eclipse
- File > Import > Existing Maven projects...
- Select all
- Close all projects that have .tests suffix (unless you want to submit some unit tests :)
- If everything compiles, make your changes, set your breakpoints and then launch a new Eclipse test workbench
- Go to Run > Debug Configurations...
- Right-click "Eclipse Application" and choose "New"
- Change name to "liferay ide test"
- Switch to "Argements" tab and add "-XX:MaxPermSize=256m" to "VM arguments"
- Click "Apply" and then click "Debug"
- When new Eclipse opens it will be the base Eclipse + your new IDE plugins running from source, so test your change and send a pull request :)!
- Once your bugfix (or feature :) is ready, build it (read the section above on how to build it) and then try it out in a brand new Eclipse install
- Send a pull request! https://github.com/gamerson/liferay-ide/pulls
Have a bug? Please file an issue at Liferay's JIRA and use the IDE project.
Read detailed announcements, discussions, and more on Liferay IDE's Blog Stream.
Have questions? Ask them on our own category for Liferay IDE on the forums
This library, Liferay IDE, is free software ("Licensed Software"); you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; including but not limited to, the implied warranty of MERCHANTABILITY, NONINFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA