mirror of
https://github.com/Alfresco/alfresco-sdk.git
synced 2025-05-19 17:15:24 +00:00
-- updated docs and readme for beta-3 release
-- updated all in one index page and referneces from docs -- added initial docs on run.sh -- linked to teaser video
This commit is contained in:
mindthegab
parent
dd270a3ca8
commit
2d6eec000d
@ -2,9 +2,11 @@
|
||||
|
||||
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:
|
||||
|
||||
It is composed of:
|
||||
[](https://www.youtube.com/watch?v=vgbY9i4w0YU)
|
||||
|
||||
The SDK is composed of:
|
||||
|
||||
- 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.
|
||||
|
||||
|
||||
@ -1,10 +1,12 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>Alfresco SDK 2.x - Running Alfresco ${alfresco.version}</title>
|
||||
<title>Alfresco SDK @@alfresco.sdk.parent.version@@ - Running Alfresco ${alfresco.version}</title>
|
||||
</head>
|
||||
<body style="font: 13px/1.231 Open Sans,arial,helvetica,clean,sans-serif;">
|
||||
<img alt="Maven Alfresco SDK" src="https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg">
|
||||
<p>Welcome to the <a href="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 <a href="https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/archetypes/alfresco-allinone-archetype/index.html">All in One project from the <a href="https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/index.html">Alfresco SDK @@alfresco.sdk.parent.version@@</a>, powered by <a href="http://maven.apache.org/">Apache Maven</a>!
|
||||
<br/>
|
||||
You can access the Alfresco components running embedded below:</p>
|
||||
<ul>
|
||||
<li><a href="/share">Alfresco Share</a></li>
|
||||
<li><a href="/alfresco">Alfresco Repository</a></li>
|
||||
@ -18,6 +20,5 @@
|
||||
<li><a href="https://issues.alfresco.com/jira/browse/ALF">Report an Alfresco issue</a></li>
|
||||
<li><a href="https://github.com/Alfresco/alfresco-sdk/issues/new">Report an SDK issue</a></li>
|
||||
</ul>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -1,9 +1,9 @@
|
||||
------
|
||||
Maven Alfresco All-in-One Archetype Advanced Usage
|
||||
Alfresco All-in-One Archetype Advanced Usage
|
||||
------
|
||||
Gabriele Columbro
|
||||
------
|
||||
Nov 2012
|
||||
Aug 2014
|
||||
------
|
||||
|
||||
|
||||
@ -15,9 +15,9 @@ All-in-One Archetype properties
|
||||
|
||||
* direclty in *.properties, particularly
|
||||
|
||||
* For Alfresco WAR projects
|
||||
* For the <<<repo>>> project
|
||||
|
||||
* <<<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)
|
||||
|
||||
* For Alfresco/Share AMP projects
|
||||
|
||||
|
||||
@ -22,14 +22,22 @@ Introduction
|
||||
|
||||
* Embedded run in Tomcat and embedded H2 database of the full Alfresco suite, including Repository, Share, Solr
|
||||
|
||||
* Support for unit and integration testings
|
||||
* Support for unit and integration testing and rapid development (using spring-loaded, see run.sh)
|
||||
|
||||
* Seamless IDE integration with Eclipse and Idea
|
||||
|
||||
How to create a project:
|
||||
|
||||
You can create the latest release archetype with the following command:
|
||||
As of version 2.0-beta-3, you can create a project with the latest released archetype with the following command directly from Maven Central:
|
||||
|
||||
+---+
|
||||
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:
|
||||
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=http://repo1.maven.org/maven2/archetype-catalog.xml
|
||||
+---+
|
||||
|
||||
For previous versions, you need to use the Alfresco Artifacts repository:
|
||||
|
||||
+---+
|
||||
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
|
||||
+---+
|
||||
|
||||
You should then:
|
||||
@ -42,7 +50,14 @@ mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:
|
||||
|
||||
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 <<<chmod u+x run.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}}
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
------
|
||||
Gabriele Columbro
|
||||
------
|
||||
Nov 2012
|
||||
Sep 2013
|
||||
------
|
||||
|
||||
Prerequisites
|
||||
@ -16,8 +16,9 @@ Project layout
|
||||
|
||||
+---+
|
||||
pom.xml
|
||||
|-> amp
|
||||
|-> alfresco
|
||||
|-> repo-amp
|
||||
|-> repo
|
||||
|-> share-amp
|
||||
|-> share
|
||||
|-> solr
|
||||
|-> 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 <<only for development purposes>>)
|
||||
@ -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:
|
||||
|
||||
* <<<mvn package>>>: 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
|
||||
|
||||
* <<<mvn jetty:run -Prun'>>> or <<<'mvn integration-test -Prun'>>> to quickly run already packaged webapps
|
||||
* <<<mvn install -Prun'>>> or <<<'mvn integration-test -Prun'>>> to quickly run already packaged webapps
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
------
|
||||
Gabriele Columbro
|
||||
------
|
||||
Nov 2012
|
||||
Spt 2014
|
||||
------
|
||||
|
||||
Introduction
|
||||
@ -27,12 +27,22 @@ Introduction
|
||||
* Embedded run in Tomcat and embedded H2 database for demo purposes, rapid application development and integration testing
|
||||
(<<NOTE>>: this is not a {{{http://www.alfresco.com/services/subscription/supported-platforms/} supported stack}} so use <<only for development purposes>>)
|
||||
|
||||
* Support for (remote) Junit and integration testing and rapid development (using spring-loaded, see run.sh)
|
||||
|
||||
* Seamless IDE integration with Eclipse and Idea
|
||||
|
||||
How to create a project:
|
||||
|
||||
You can create the latest release archetype with the following command:
|
||||
As of version 2.0-beta-3, you can create a project with the latest released archetype with the following command directly from Maven Central:
|
||||
|
||||
+---+
|
||||
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:
|
||||
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=http://repo1.maven.org/maven2/archetype-catalog.xml
|
||||
+---+
|
||||
|
||||
For previous versions, you need to use the Alfresco Artifacts repository:
|
||||
|
||||
+---+
|
||||
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
|
||||
+---+
|
||||
|
||||
You should then:
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
------
|
||||
Maven Alfresco AMP Archetype Advanced Usage
|
||||
Alfresco Share AMP Archetype Advanced Usage
|
||||
------
|
||||
Gabriele Columbro
|
||||
------
|
||||
Nov 2012
|
||||
------
|
||||
|
||||
AMP Unit Testing
|
||||
Unit Testing
|
||||
|
||||
Unit test your AMP customization is as easy as adding your tests in <<<src/test/java>>>. The current module in development
|
||||
will be added to the test classpath together with all necessary Alfresco Spring contexts.
|
||||
@ -14,9 +14,9 @@ AMP Unit Testing
|
||||
Running <<<mvn test>>> will results in your unit tests to be run. You can skip this (<<<not recommended>>>)
|
||||
adding <<<-DskipTests>>> to your command line.
|
||||
|
||||
AMP Archetype properties
|
||||
Share AMP Archetype properties
|
||||
|
||||
In the AMP archetype (as in the whole Part of the Maven Alfresco SDK\x99) properties are configurable at many levels:
|
||||
In the AMP archetype (as in the whole Alfresco SDK\x99) properties are configurable at many levels:
|
||||
|
||||
* as POM properties
|
||||
|
||||
@ -24,8 +24,6 @@ AMP Archetype properties
|
||||
|
||||
* <<<src/main/amp/module.properties>>> (filtered and packaged in the AMP)
|
||||
|
||||
* <<<src/test/properties/<env>/alfresco-global.properties>>> (environment dependent properties for WAR run embedded)
|
||||
|
||||
* Common properties
|
||||
|
||||
Archetype behavior can mostly be controlled directly in the POM, via common properties provided by the parent POM.
|
||||
|
||||
@ -21,20 +21,25 @@ Introduction
|
||||
|
||||
* Installation of AMPs in an Alfresco or Share WAR
|
||||
|
||||
* AMP Unit Testing support. Just run the standard <<<mvn test>>> and see your <<<src/test/java>>> Alfresco unit tests run.
|
||||
An sample Unit Test is provided in this archetype.
|
||||
* AMP Unit Testing support. Just run the standard <<<mvn test>>> and see your <<<src/test/java>>> Alfresco unit tests run.
|
||||
|
||||
* Embedded run in Tomcat and embedded H2 database for demo purposes, rapid application development and integration testing
|
||||
(<<NOTE>>: this is not a {{{http://www.alfresco.com/services/subscription/supported-platforms/} supported stack}} so use <<only for development purposes>>)
|
||||
* Support for unit and integration testing and rapid development (using spring-loaded, see run.sh)
|
||||
|
||||
* Seamless IDE integration with Eclipse and Idea
|
||||
|
||||
How to create a project:
|
||||
|
||||
You can create the latest release archetype with the following command:
|
||||
As of version 2.0-beta-3, you can create a project with the latest released archetype with the following command directly from Maven Central:
|
||||
|
||||
+---+
|
||||
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:
|
||||
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=http://repo1.maven.org/maven2/archetype-catalog.xml
|
||||
+---+
|
||||
|
||||
For previous versions, you need to use the Alfresco Artifacts repository:
|
||||
|
||||
+---+
|
||||
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
|
||||
+---+
|
||||
You should then:
|
||||
|
||||
[[1]] Select the <<<share-amp-archetype>>> option
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user