[weld-commits] Weld SVN: r5328 - in archetypes/trunk/jsf/jee/src/main/resources: archetype-resources and 1 other directory.

Thu Dec 17 12:35:34 EST 2009

Author: dan.j.allen
Date: 2009-12-17 12:35:33 -0500 (Thu, 17 Dec 2009)
New Revision: 5328

Added:
   archetypes/trunk/jsf/jee/src/main/resources/archetype-resources/readme.txt
Modified:
   archetypes/trunk/jsf/jee/src/main/resources/META-INF/maven/archetype-metadata.xml
Log:
add readme.txt to jee


Modified: archetypes/trunk/jsf/jee/src/main/resources/META-INF/maven/archetype-metadata.xml
===================================================================

--- archetypes/trunk/jsf/jee/src/main/resources/META-INF/maven/archetype-metadata.xml	2009-12-17 17:28:49 UTC (rev 5327)
+++ archetypes/trunk/jsf/jee/src/main/resources/META-INF/maven/archetype-metadata.xml	2009-12-17 17:35:33 UTC (rev 5328)
@@ -7,6 +7,12 @@
    </requiredProperties>
    <fileSets>
       <fileSet filtered="true" packaged="false">
+         <directory/>
+         <includes>
+           <include>readme.txt</include>
+         </includes>
+      </fileSet>
+      <fileSet filtered="true" packaged="false">
          <directory>src/main/webapp</directory>
          <includes>
            <include>index.jsp</include>

Added: archetypes/trunk/jsf/jee/src/main/resources/archetype-resources/readme.txt
===================================================================
--- archetypes/trunk/jsf/jee/src/main/resources/archetype-resources/readme.txt	                        (rev 0)
+++ archetypes/trunk/jsf/jee/src/main/resources/archetype-resources/readme.txt	2009-12-17 17:35:33 UTC (rev 5328)
@@ -0,0 +1,109 @@
+                              ${artifactId} 
+
+ What is it?
+ ===========
+
+ This is your project! It's a sample, deployable Maven 2 project to help you
+ get your foot in the door developing with Java EE 6. This project is setup to
+ allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0,
+ EJB 3.1 and JPA 2.0) that can run on a certified application server (Full or
+ Web Profile). It includes a persistence unit and some sample persistence and
+ transaction code to help you get your feet wet with database access in
+ enterprise Java. 
+
+ System requirements
+ ===================
+
+ All you need to run this project is Java 5.0 (Java SDK 1.5) or greator and
+ Maven 2.0.10 or greater. This application is setup to be run on a Java EE 6
+ certified application server. It has been tested with GlassFish V3 and JBoss
+ AS 6.0.
+
+ If you want to deploy the application to a standalone Servlet Container, then
+ you will need to set one up. Alternatively, you can use a Maven command to run
+ the application in place on an embedded version of GlassFish.
+
+ Deploying the application
+ =========================
+
+ You can deploy the application without moving any files around using the
+ embedded GlassFish application server.
+
+ To run the application using embedded GlassFish, execute this command:
+
+  mvn package embedded-glassfish:run
+
+ The application will be running at the following URL:
+ 
+  http://localhost:7070/${artifactId}
+
+ To deploy the application to JBoss AS (standalone), first make sure that the
+ JBOSS_HOME environment variable points to a JBoss AS 6.0 installation.
+ Alternatively, you can set the location of JBoss AS using the following
+ profile defintion in your $HOME/.m2/settings.xml file:
+
+<?xml version="1.0" encoding="UTF-8"?>
+<settings
+   xmlns="http://maven.apache.org/POM/4.0.0"
+   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+   <profiles>
+      <profile>
+         <id>environment</id>
+         <activation>
+            <activeByDefault>true</activeByDefault>
+         </activation>
+         <properties>
+            <jboss.home>${user.home}/opt/jboss-as-6.0.0.M1</jboss.home>
+         </properties>
+      </profile>
+   </profiles>
+   
+</settings>
+
+ You can now deploy to JBoss AS by executing the following command:
+
+  mvn package jboss:hard-deploy
+
+ Start JBoss AS. The application will be running at the following URL:
+
+  http://localhost:8080/${artifactId}
+
+ If you want to deploy to GlassFish (standalone), you can upload the
+ target/${artifactId}.war archive using the web-based administration console.
+
+ Importing the project into an IDE
+ =================================
+
+ If you created the project using the Maven 2 archetype wizard in your IDE
+ (Eclipse, NetBeans or IntelliJ IDEA), then there is nothing to do. You should
+ already have an IDE project.
+
+ If you created the project from the commandline using archetype:generate, then
+ you need to bring the project into your IDE. If you are using NetBeans 6.8 or
+ IntelliJ IDEA 9, then all you have to do is open the project as an existing
+ project. Both of these IDEs recognize Maven 2 projects natively.
+
+ To import into Eclipse, you first need to install the m2eclipse plugin. To get
+ started, add the m2eclipse update site (http://m2eclipse.sonatype.org/update/)
+ to Eclipse and install the m2eclipse plugin and required dependencies. Once
+ that is installed, you'll be ready to import the project into Eclipse.
+
+ Select File > Import... and select "Import... > Maven Projects" and select
+ your project directory. m2eclipse should take it from there.
+
+ Once in the IDE, you can execute the Maven commands through the IDE controls
+ to run the application on an embedded Servlet Container.
+
+ Resources
+ =========
+
+ Weld archetypes:
+ -  Quickstart:        http://seamframework.org/Documentation/WeldQuickstartForMavenUsers
+ -  Issue tracker:     https://jira.jboss.org/jira/browse/WELDX
+ -  Source code:       http://anonsvn.jboss.org/repos/weld/archetypes
+ -  Forums:            http://seamframework.org/Community/WeldUsers
+ JSR-299 overview:     http://seamframework.org/Weld
+ JSF community site:   http://www.javaserverfaces.org
+

