Alfresco SDK
SDK for Alfresco Development, Testing, packaging and custom project lifecycle management based on Apache Maven.
Includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects.
SDK 2.0.0 available in Maven Central
The SDK 2.0.0 is finally released in Maven Central.
- To create a new Alfresco project: Run a
mvn archetype:generate -Dfilter=org.alfresco:
and use one of the available archetypes (AMP, Share AMP, All in One)
- To use the SDK in your project: Add the below parent reference snippet to the existing project (NOTE: you might need folder layout changes) to inherit features from Alfresco SDK POM:
<parent>
<groupId>org.alfresco.maven</groupId>
<artifactId>alfresco-sdk-parent</artifactId>
<version>2.0.0</version>
</parent>
Resources
Alfresco Official Docs
-
Documentation for the SDK on Alfresco Community (latest) is available here
-
Documentation for the SDK on Alfresco Enterprise (5.0) is available here
Developer Documentation
SDK 2.x: Full developer (Maven) documentation is available at the Alfresco SDK site.
Check the SDK in action!
For an overview of the SDK potential check out this video:
The SDK is composed of:
- An SDK Parent POM which you can use in your projects to enable rapid Alfresco development features
- An Alfresco Platform Distribution POM which pre-configures versions of Alfresco and common 3rd party dependency libraries, for stability purposes
- A Maven Alfresco Plugin which provides AMP packaging and installation facilities (a la MMT) and other common goals for Alfresco development
- A number of Maven Archetypes (sample projects) including:
Samples
Advanced sample projects are maintained by @ohej in the Alfresco SDK Samples project.
Contribute
Report issues (and contribute!) here. You can also join the Alfresco list on Google Groups.
Maven Repositories
The Alfresco SDK is released in Maven Central as of version 2.0-beta-1.
Alfresco (Community and Enterprise) artifacts are instead hosted in the Alfresco Artifacts Repository.
Alfresco Community artifacts (JARs, WARs, AMPs, poms) and SDK artifacts are publicly available.
for Enterprise and Premiere licensed software access you need to get credential via the Alfresco Enterprise Support. See public docs or this KB (login required) for more details.
License and Support
This project is released under the Apache License, Version 2.0. It's a community driven project which is supported for Alfresco Development (please refere to the official Alfresco Documentation for supported features.
News
- 2014-12-20: SDK 2.0.0 in staging. If you want early access to the release candidate build and want to participate to the testing process check this page and report issues here.
- 2014-09-10: SDK 2.0.0-beta-4 released to Maven Central and in the Archetype Catalog!
- 2014-09-09: SDK 2.0.0-beta-3 released to Maven Central
- 2014-08-30: SDK 2.0.0-beta-1 and 2.0.0-beta-2 available in Maven Central
- 2014-08-22: First SNAPSHOT of SDK 2.0.0 in the OSS Sonatype Repository!
- 2014-07: Project fully migrated from Google Code, including tags, branches, issues. Allow a little time for a full cleanup of issue labels and to sort repository permissions. Please update obsolete references and bear with us as we update Alfresco Documentation to this change.