Developer Wiki

The following section describes how to build the SDK from source and how to generate projects based on the local build.

Prerequisites

Make sure you have setup and configured Maven, Docker, JDK, etc, see Alfresco Documentation.

For Maven specific information

Check out the generated Maven Site.

Building from Source

Get the SDK source:

$ git clone https://github.com/Alfresco/alfresco-sdk.git

Step into the parent SDK project:

$ cd alfresco-sdk

Build the SDK and skip tests (skipping tests is useful for quicker builds):

alfresco-sdk$ mvn clean install -DskipTests

Run tests (by default only tests against Alfresco Community are run)

alfresco-sdk$ mvn clean install

Run tests for a specific Alfresco Community / Enterprise version (enable the corresponding profile)

alfresco-sdk$ mvn clean install -Penterprise-61-tests

Run tests with a Docker Toolbox (old Windows and MacOS) installation environment (configure and enable docker-toolbox profile)

alfresco-sdk$ mvn clean install -Pdocker-toolbox

Generating an extension project from the local build

$ mvn archetype:generate -DarchetypeCatalog=local

This project is released under the Apache License, Version 2.0. It's a community driven project which is supported for Alfresco Development (please refer to the official Alfresco Documentation for supported features).