Building from Source

WSO2 invites you to contribute by downloading the source code from the GitHub source control system, building the product and making changes, and then committing your changes back to the source repository by sending a pull request for review. For information on using the Git version control system, see the Git documentation. The following sections describe this process:

Building from source is optional. Users who do not want to make changes to the source code can simply install Developer Studio.

Checking out the source

You can either clone or fork the WSO2 Developer Studio Git repository and build from source.

To clone the repository, run the following command:

$ git clone https://github.com/wso2/developer-studio.git

Editing the source code

Now that you have downloaded the source code from GitHub, you can prepare your development environment and do the required changes to the code.

To edit the source code in Eclipse, set up your development environment by the following command:
IDE Command Additional information
Eclipse mvn eclipse:eclipse http://maven.apache.org/plugins/maven-eclipse-plugin
If you are using a later Eclipse version and if you get errors (library path etc.) when trying to import the source code using the Existing Projects into Workspace option, you can solve them by importing the source code as a Maven project. To do this; open Eclipse and click Import in the File menu and then click Existing Maven Projects as shown below:
Add the required changes to the source code.

Building the product

Ensure that the following prerequisites are in place before you build:

Make sure the build server has an active Internet connection to download dependencies while building.
Install Maven and JDK. For compatible versions, see Installation Prerequisites.
Set the environment variable MAVEN_OPTS=”-Xms1024m -Xmx4096m -XX:MaxPermSize=1024m” to avoid the Maven OutOfMemoryError.

Use the following Maven commands to build your product:

Command	Description
`mvn clean install`	The binary and source distributions.
`mvn clean install -Dmaven.test.skip=true`	The binary and source distributions, without running any of the unit tests.
`mvn clean install -Dmaven.test.skip=true -o`	The binary and source distributions, without running any of the unit tests, in offline mode. This can be done only if you have already built the source at least once.

Committing your changes

You can contribute to WSO2 products by committing your changes to GitHub. Whether you are a committer or a non-committer, you can contribute with your code as explained in the Get Involved section.