[Ecforms-commit] ECF-JSF README.txt,NONE,1.1

[Francisco C. <fca...@us...>]

Update of /cvsroot/ecforms/ECF-JSF
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2579

Added Files:
	README.txt 
Log Message:
ReadMe file

--- NEW FILE: README.txt ---
ECForms - version 0.2, November 2005
====================================

Framework to build Java Server Faces web applications using a simple scripting 
language (IENJINIA Programming Language). 

This framework is built on top of Java Server Faces and the IENJINIA 
PROGRAMMING LANGUAGE (http://sourceforge.net/projects/ienjinia) to provide an 
easy-to-learn environment to develop Java Web applications. 

It benefits from the flexibility provided by the Java Server Faces 
architecture, providing a unified syntax to code the different type of 
components (navigation, logic, pages, etc).


1. Status:
----------
We have now two modules: 
- This module (ECF-JSF), the full ECF version.
- The ECF-Servlet module, which is a light version of ECF without the JSF
built-in functions.


2. Source Code:
---------------
You can see what we are working on by checking out the "ECF-JSF" module
from the CVS repository

To check out the ECF-JSF module:
cvs -d :pserver:ano...@cv...:/cvsroot/ecforms login
cvs -z3 -d :pserver:ano...@cv...:/cvsroot/ecforms co ECF-JSF

Or you can browse the CVS repository at:

http://cvs.sourceforge.net/viewcvs.py/ecforms/ECF-JSF



3. Execute:
-----------

To build a new project "from scrath", execute the following commands:

(1) "ant" (or "ant create-project").
You will be prompted for the following properties:
    * Base directory (from now on <basedir>)
    * Name of project (from now on <project.name>)
    * Sample or blank project (<sample> if you want to see some template code
    and working demos, <blank> if you really prefer to start "from scratch")

(2) cd <basedir>/<project.name>

(3) Make the desired changes to the following files:
    a) Webapp screenflows: ipl/ecf.ipl
    b) Database logic: ipl/db.ipl
    c) Static content: resources/*.*
    c) Property files (internationalization messages) and Java source files: src/*.*

(4) If you want to deploy an expanded webapp on Tomcat, use "ant";
if you prefer to create the war file use "ant package"

(5) Point your browser to http://localhost:8080/<project.name>



4. Requirements:
----------------
(1) You need to define an environment variable named TOMCAT_HOME, which points
to the installation directory of Tomcat.

Steps 2 and 3 are optional for blank projects:

(2) For configuring the application security, you need to add a user with role
"tomcat"; you can do this by editing the tomcat-users.xml file
(under TOMCAT_HOME/conf), such as:
  <role rolename="tomcat"/>
  <user username="guest" password="tomcat" roles="tomcat"/>


(3) To enable JDBC support from ECF:

(a) Configuring the jdbc/ECFDB datasource in Tomcat, add the following lines at
the end of the hosts section in the server.xml file (under TOMCAT_HOME/conf),
such as:
<Context path="/ECF" docBase="ECF" debug="5" reloadable="true" crossContext="true">
  <Resource name="jdbc/ECFDB" auth="Container" type="javax.sql.DataSource"/>
  <ResourceParams name="jdbc/ECFDB">
    <parameter>
      <name>factory</name>
      <value>org.apache.commons.dbcp.BasicDataSourceFactory</value>
    </parameter>
    <parameter>
      <name>maxActive</name>
      <value>10</value>
    </parameter>
    <parameter>
      <name>maxIdle</name>
      <value>3</value>
    </parameter>
    <parameter>
      <name>maxWait</name>
      <value>5000</value>
    </parameter>
    <parameter>
      <name>username</name>
      <value>username</value>
    </parameter>
    <parameter>
      <name>password</name>
      <value>password</value>
    </parameter>
    <parameter>
      <name>driverClassName</name>
      <value>org.gjt.mm.mysql.Driver</value>
    </parameter>
    <parameter>
      <name>url</name>
      <value>jdbc:mysql://localhost:3306/ecftest?autoReconnect=true</value>
    </parameter>
  </ResourceParams>
</Context>

(b) Add the JDBC driver for mysql under TOMCAT_HOME/common/lib

(c) Execute the following script in MySQL:
create database ecftest;
use ecftest;
create table persons(name varchar(30), age integer);



Other Stuff
-----------
This software is distributed under the terms of the GNU General Public License (see License.txt).

If you want to contribute, go to http://sourceforge.net/projects/ecforms/