You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2013/02/12 13:13:58 UTC
svn commit: r1445123 -
/isis/site/trunk/content/getting-started/quickstart-archetype.md
Author: danhaywood
Date: Tue Feb 12 12:13:57 2013
New Revision: 1445123
URL: http://svn.apache.org/r1445123
Log:
CMS commit to isis by danhaywood
Modified:
isis/site/trunk/content/getting-started/quickstart-archetype.md
Modified: isis/site/trunk/content/getting-started/quickstart-archetype.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/getting-started/quickstart-archetype.md?rev=1445123&r1=1445122&r2=1445123&view=diff
==============================================================================
--- isis/site/trunk/content/getting-started/quickstart-archetype.md (original)
+++ isis/site/trunk/content/getting-started/quickstart-archetype.md Tue Feb 12 12:13:57 2013
@@ -1,91 +1,91 @@
-Title: Quickstart Archetype
-
-The quickest way to get started with Apache Isis is to run the quickstart archetype. This will generate a simple one-class domain model, for tracking to-do items. The intention is not to showcase all of Isis' capabilities; rather it is to allow you to very easily modify the generated app to your own domain.
-
-### Generating the App
-
-Create a new directory, and `cd` into that directory.
-
-Then run the following command:
-
-<pre>
-mvn archetype:generate \
- -D archetypeGroupId=org.apache.isis.archetype \
- -D archetypeArtifactId=quickstart_wicket_restful_jdo-archetype \
- -D archetypeVersion=1.0.2 \
- -D groupId=com.mycompany \
- -D artifactId=myapp
-</pre>
-where:
-
-- `groupId` represents your own organization, and
-- `artifactId` is a unique identifier for this app within your organization.
-
-You'll then be prompted for some further properties; you can generally leave these as the default:
-
-- enter a version, eg `1.0-SNAPSHOT`
-- enter a package
-- confirm the entry
-
-The archetype generation process will then run; it only takes a few seconds.
-
-### Building the App
-
-Switch into the root directory of your newly generated app, and build your app:
-
-<pre>
-cd myapp
-mvn clean install
-</pre>
-
-where `myapp` is the `artifactId` entered above.
-
-### Running the App
-
-The `quickstart_wicket_restful_jdo` archetype generates a single WAR file, configured to run both the [Wicket viewer](../components/viewers/wicket/about.html) and the [Restful Objects viewer](../components/viewers/wicket/about.html). The archetype also configures the [JDO Objectstore](../components/objectstores/jdo/about.html) to use an in-memory HSQLDB connection.
-
-Once you've built the app, you can run the WAR in a variety of ways.
-
-The recommended approach when getting started is to run the self-hosting version of the WAR, allowing Isis to run as a standalone app; for example:
-
-<pre>
-java -jar viewer-wicket/target/myapp-viewer-wicket-1.0-SNAPSHOT-jetty-console.war
-</pre>
-
-This can also be accomplished using an embedded Ant target provided in the build script:
-
-<pre>
-mvn antrun:run
-</pre>
-The first is to simply deploying the generated WAR (`webapp/target/myapp-webapp-1.0-SNAPSHOT.war`) to a servlet container.
-
-Alternatively, you could run the WAR in a Maven-hosted Jetty instance, using:
-
-<pre>
-mvn jetty:run
-</pre>
-
-If you do this, note that the context path changes; check the console output.
-
-Finally, you can also run the app by deploying to a standalone servlet container such as [Tomcat](http://tomcat.apache.org).
-
-### Using the App
-
-The archetype provides a welcome page that explains the classes and files generated, and provides detailed guidance and what to do next.
-
-The app itself is configured to run using shiro security, as configured in the `WEB-INF/shiro.ini` config file. To log in, use `sven/pass`.
-
-### App Structure
-
-As noted above, the generated app is a very simple application consisting of a single domain object for tracking to-do items. The intention is not to showcase all of Isis' capabilities; rather it is to allow you to very easily modify the generated application (eg rename `ToDoItem` to `Customer`) without having to waste time deleting lots of generated code.
-
-<table>
-<tr><th>Module</th><th>Description</th></tr>
-<tr><td>myapp</td><td>The parent (aggregator) module</td></tr>
-<tr><td>myapp-dom</td><td>The domain object model, consisting of <tt>ToDoItem</tt> and <tt>ToDoItems</tt> (repository) interface.</td></tr>
-<tr><td>myapp-fixture</td><td>Domain object fixtures used for initializing the system when being demo'ed or for unit testing.</td></tr>
-<tr><td>myapp-objstore-jdo</td><td>Implementation of <tt>ToDoItems</tt> repository, using JDO objectstore.</td></tr>
-<tr><td>myapp-viewer-webapp</td><td>Run as a webapp (from <tt>web.xml</tt>) using either the Wicket viewer or the RestfulObjects viewer</td></tr>
-</table>
-
-If you run into issues, please don't hesitate to ask for help on the [users mailing list](../support.html).
+Title: Quickstart Archetype
+
+The quickest way to get started with Apache Isis is to run the quickstart archetype. This will generate a simple one-class domain model, for tracking to-do items. The intention is not to showcase all of Isis' capabilities; rather it is to allow you to very easily modify the generated app to your own domain.
+
+### Generating the App
+
+Create a new directory, and `cd` into that directory.
+
+Then run the following command:
+
+<pre>
+mvn archetype:generate \
+ -D archetypeGroupId=org.apache.isis.archetype \
+ -D archetypeArtifactId=quickstart_wicket_restful_jdo-archetype \
+ -D archetypeVersion=1.0.2 \
+ -D groupId=com.mycompany \
+ -D artifactId=myapp
+</pre>
+where:
+
+- `groupId` represents your own organization, and
+- `artifactId` is a unique identifier for this app within your organization.
+
+You'll then be prompted for some further properties; you can generally leave these as the default:
+
+- enter a version, eg `1.0-SNAPSHOT`
+- enter a package
+- confirm the entry
+
+The archetype generation process will then run; it only takes a few seconds.
+
+### Building the App
+
+Switch into the root directory of your newly generated app, and build your app:
+
+<pre>
+cd myapp
+mvn clean install
+</pre>
+
+where `myapp` is the `artifactId` entered above.
+
+### Running the App
+
+The `quickstart_wicket_restful_jdo` archetype generates a single WAR file, configured to run both the [Wicket viewer](../components/viewers/wicket/about.html) and the [Restful Objects viewer](../components/viewers/wicket/about.html). The archetype also configures the [JDO Objectstore](../components/objectstores/jdo/about.html) to use an in-memory HSQLDB connection.
+
+Once you've built the app, you can run the WAR in a variety of ways.
+
+The recommended approach when getting started is to run the self-hosting version of the WAR, allowing Isis to run as a standalone app; for example:
+
+<pre>
+java -jar viewer-webapp/target/myapp-viewer-webapp-1.0-SNAPSHOT-jetty-console.war
+</pre>
+
+This can also be accomplished using an embedded Ant target provided in the build script:
+
+<pre>
+mvn antrun:run
+</pre>
+The first is to simply deploying the generated WAR (`webapp/target/myapp-webapp-1.0-SNAPSHOT.war`) to a servlet container.
+
+Alternatively, you could run the WAR in a Maven-hosted Jetty instance, using:
+
+<pre>
+mvn jetty:run
+</pre>
+
+If you do this, note that the context path changes; check the console output.
+
+Finally, you can also run the app by deploying to a standalone servlet container such as [Tomcat](http://tomcat.apache.org).
+
+### Using the App
+
+The archetype provides a welcome page that explains the classes and files generated, and provides detailed guidance and what to do next.
+
+The app itself is configured to run using shiro security, as configured in the `WEB-INF/shiro.ini` config file. To log in, use `sven/pass`.
+
+### App Structure
+
+As noted above, the generated app is a very simple application consisting of a single domain object for tracking to-do items. The intention is not to showcase all of Isis' capabilities; rather it is to allow you to very easily modify the generated application (eg rename `ToDoItem` to `Customer`) without having to waste time deleting lots of generated code.
+
+<table>
+<tr><th>Module</th><th>Description</th></tr>
+<tr><td>myapp</td><td>The parent (aggregator) module</td></tr>
+<tr><td>myapp-dom</td><td>The domain object model, consisting of <tt>ToDoItem</tt> and <tt>ToDoItems</tt> (repository) interface.</td></tr>
+<tr><td>myapp-fixture</td><td>Domain object fixtures used for initializing the system when being demo'ed or for unit testing.</td></tr>
+<tr><td>myapp-objstore-jdo</td><td>Implementation of <tt>ToDoItems</tt> repository, using JDO objectstore.</td></tr>
+<tr><td>myapp-viewer-webapp</td><td>Run as a webapp (from <tt>web.xml</tt>) using either the Wicket viewer or the RestfulObjects viewer</td></tr>
+</table>
+
+If you run into issues, please don't hesitate to ask for help on the [users mailing list](../support.html).