Maven Alfresco SDK for Alfresco Development and Customizations based on Apache Maven.
Includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects.
Includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects. For a teaser of the SDK potential check out this video:
- An [SDK Parent POM](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-lifecycle-aggregator/latest/poms/alfresco-sdk-parent/index.html) which you can use in your projects to enable rapid Alfresco development features
- An [Alfresco Platform Distribution POM](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-platform-distribution/latest/index.html) which pre-configures versions of Alfresco and common 3rd party dependency libraries, for stability purposes
@@ -48,6 +50,8 @@ This project is released under the [Apache License, Version 2.0](http://www.apac
## News
- 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](http://search.maven.org/#search|ga|1|org.alfresco.maven)
- 2014-08-22: First SNAPSHOT of SDK 2.0.0 in the [OSS Sonatype Repository](https://oss.sonatype.org/content/repositories/snapshots/org/alfresco/maven/alfresco-sdk-parent/2.0.0-SNAPSHOT/)!
- 2014-07: Project fully migrated from [Google Code](https://code.google.com/p/maven-alfresco-archetypes), 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.
<p>Welcome to the <ahref="https://github.com/Alfresco/alfresco-sdk/">Alfresco SDK</a> powered by Apache Maven! You can access the Alfresco components running embedded below:</p>
<p>Congratulations, you are successfully running the <ahref="https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/archetypes/alfresco-allinone-archetype/index.html">All in One project from the <ahref="https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/index.html">Alfresco SDK @@alfresco.sdk.parent.version@@</a>, powered by <ahref="http://maven.apache.org/">Apache Maven</a>!
<br/>
You can access the Alfresco components running embedded below:</p>
* <<<src/main/properties/<env>/alfresco-global.properties>>> (environment dependent <<<alfresco-global.properties>>> packaged in the WAR )
* <<<src/main/properties/<env>/alfresco-global.properties>>> (environment dependent <<<alfresco-global.properties>>> packaged in the WAR when running directly within the AMP project)
You can find new Alfresco All-in-One project ready to go in the <<<artifactId>>> folder.
Quickstart
Once your project is created, enter the project folder and run <<<./run.sh>>> (you might need to <<<chmodu+xrun.sh>>> to make it executable. Wait for the startup of the webapps and then go <<<http://localhost:8080>>>.
This will start Alfresco, Share and Solr. You can import the projects in your favorite IDE (with Maven integration) and start
developing right away.
Usage
Instructions on how to use the Alfresco All in One archetype can be found on the {{{./usage.html}usage page}}, while
Full instructions on how to use the Alfresco All in One archetype can be found on the {{{./usage.html}usage page}}, while
for more advanced use cases refer to the {{{./advanced-usage.html}advanced usage page}}
|-> runner (a Tomcat embedded runner / integration test runner)
@@ -48,7 +49,7 @@ Usage
* AMP/WAR packaging
* AMP Unit testing
* AMP Unit testing and rapid development
* run embedded in Tomcat + H2 database.
(<<NOTE>>: this is not a {{{http://www.alfresco.com/services/subscription/supported-platforms/} supported stack}} so use <<onlyfordevelopmentpurposes>>)
@@ -65,9 +66,11 @@ Usage
Commands
* Commands from the root aggregator project
* Commands from the root aggregator project:
Common Alfresco project lifecycle commands you want to run from the aggregator :
* <<<run.sh>>> will automatically set up the SDK and run embedded to enable rapid development
* Additional Common Maven lifecycle commands you want to run from the aggregator are:
* <<<mvnpackage>>>: Runs unit tests and packages all customized modules in their respective <<<$\{project.build.directory\}/$\{project.build.finalName\}.amp>>>
@@ -81,4 +84,4 @@ Commands
* Commands from from the <<<runner>>> project
* <<<mvnjetty:run-Prun'>>> or <<<'mvnintegration-test-Prun'>>> to quickly run already packaged webapps
* <<<mvninstall-Prun'>>> or <<<'mvnintegration-test-Prun'>>> to quickly run already packaged webapps