Author: danhaywood
Date: Thu Jan 10 18:43:50 2013
New Revision: 1431552
URL: http://svn.apache.org/viewvc?rev=1431552&view=rev
Log:
isis site - updating archetype page
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=1431552&r1=1431551&r2=1431552&view=diff
==============================================================================
--- isis/site/trunk/content/getting-started/quickstart-archetype.md (original)
+++ isis/site/trunk/content/getting-started/quickstart-archetype.md Thu Jan 10
18:43:50 2013
@@ -1,4 +1,4 @@
-Title: Quickstart Archetype (1.0.0)
+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.
@@ -12,7 +12,7 @@ Then run the following command:
mvn archetype:generate \
-D archetypeGroupId=org.apache.isis.archetype \
-D archetypeArtifactId=quickstart_wicket_restful_jdo-archetype \
- -D archetypeVersion=1.0.0 \
+ -D archetypeVersion=1.0.1 \
-D groupId=com.mycompany \
-D artifactId=myapp
</pre>
@@ -42,37 +42,38 @@ where `myapp` is the `artifactId` entere
### Running the App
-The `quickstart_wicket_restful_jdo` archetype generates two WAR files, one for
the [wicket viewer](../components/viewers/wicket/about.html) and one for the
[restfulobjects viewer](../components/viewers/wicket/about.html). You can
deploy either or both. The wicket viewer WAR is built by the `viewer-wicket`
module; the restful objects viewer WAR is built by the `viewer-restfulobjects`
module.
+The `quickstart_wicket_restful_jdo` archetype generates a single WAR files,
configured to run both the [wicket
viewer](../components/viewers/wicket/about.html) and the [restfulobjects
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.
-By default each run with JDO objectstore configured to use an in-memory HSQLDB
connection. To share data between the webapps (or indeed to persist data
between runs), you'll therefore need to reconfigure both webapps to use some
other shared database connection. See the `persistor_datanucleus.properties`
file for details.
+Once you've built the app, you can run the WAR in a variety of ways.
-Once you've built the app (having reconfigured JDO if required), you can run
either WAR in a variety of ways.
-
-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:
+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>
-mvn jetty:run
+java -jar
viewer-wicket/target/myapp-viewer-wicket-1.0-SNAPSHOT-jetty-console.war
</pre>
-If you do this, note that the context path changes; check the console output.
-
-In addition to the standard WAR< the archetype also builds a self-hosted
version of the WAR. You can therefore also simply run the WAR as a standalone
app; for example:
+This can also be accomplished using an embedded Ant target provided in the
build script:
<pre>
-java -jar
viewer-wicket/target/myapp-viewer-wicket-1.0-SNAPSHOT-jetty-console.war
+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.
-This can also be accomplished using an embedded Ant target provided in the
build script:
+Alternatively, you could run the WAR in a Maven-hosted Jetty instance, using:
<pre>
-mvn antrun:run
+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 app itself is configured to run using basic security, as configured in the
`security_file.passwords` config file. to log in, use `sven/pass`.
+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
@@ -84,8 +85,7 @@ As noted above, the generated app is a v
<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-wicket-viewer</td><td>Run as a webapp (from <tt>web.xml</tt>)
using the Wicket viewer</td></tr>
-<tr><td>myapp-wicket-restfulobjects</td><td>Run as a webapp (from
<tt>web.xml</tt>) using the RestfulObjects viewer</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).
\ No newline at end of file
+If you run into issues, please don't hesitate to ask for help on the [users
mailing list](../support.html).
