Project

General

Profile

Documentation » History » Revision 22

Revision 21 (chin-yeh, 09/23/2011 09:54 AM) → Revision 22/23 (chin-yeh, 09/23/2011 09:54 AM)

{{toc}} 

 h1. Documentation 

 The main documentation for *VP Client*. 

 h2. Programming Guide 

 See [[Programming Guide]] 

 h2. Deployment Guide 

 * [[Deploy vp-client]] 
 * [[Deploy vp-batch]] 

 h2. List of Components 

 |_.Name|_.Latest Stable Version|_.Description| 
 |vp-stub|1.0-[version]|the client stub of the VP web services| 
 |vp-client|1.0.3-[version]|the client application of the VP web services| 
 |vp-test|1.0.3-SNAPSHOT|the demo application for *vp-client*| 
 |vp-batch|HEAD tag|the batch program| 

 where *version* refer to: 
 * *SNAPSHOT* - for development environment 
 * *RELEASE* - for production environment 

 h2. Compile from source files 

 *Important Note:* 
 > This section is not applicable to *vp-batch* as its deployment files have to be compiled individually and only upload those which are needed. 

 All of the projects are built and maintained using "Maven 2":http://maven.apache.org/.  
 > Those projects can be imported into *Eclipse IDE* but the *m2 Maven* plugin is needed. 

 The source files are stored in: 
 > [[wiki#scm|SCM]] 

 *Prerequisite:* 
 * Eclipse IDE (optional) 
 * Apache Maven 2 
 * CVS client, e.g TortoiseCVS, Eclipse IDE 
 * Project or module name, e.g. vp-client 

 All of the project is configured to include *development properties files* when packaging the binary file. To include production properties files, activate the *prod* profile. 

 *Steps:* 
 # checkout the project or module using the CVS client 
 # <code>cd</code> to the checkout folder, e.g. vp-client 
 ** *Example:* 
 <pre> 
 $ cd vp-client 
 </pre> 
 # execute the maven goal, *clean* and *package*: 
 ** compile for *development* environment: 
 *** change the artifact version to *x.x-SNAPSHOT* 
 <pre> 
 $ mvn clean package 
 </pre> 
 ** compile for *production* environment: 
 *** change the artifact version to *x.x-RELEASE* 
 <pre> 
 $ mvn -P prod clean package 
 </pre> 
 # if success, the binary file can be found in the *target* folder