Project

General

Profile

Documentation » History » Version 23

chin-yeh, 10/31/2011 04:58 PM

1 2 chin-yeh
{{toc}}
2
3 1 chin-yeh
h1. Documentation
4 3 chin-yeh
5 22 chin-yeh
The main documentation for *VP Client*.
6
7 21 chin-yeh
h2. Programming Guide
8
9
See [[Programming Guide]]
10
11
h2. Deployment Guide
12
13
* [[Deploy vp-client]]
14
* [[Deploy vp-batch]]
15
16 3 chin-yeh
h2. List of Components
17
18 7 chin-yeh
|_.Name|_.Latest Stable Version|_.Description|
19 23 chin-yeh
|vp-stub|1.0-RELEASE|the client stub of the VP web services|
20 13 chin-yeh
|vp-client|1.0.3-[version]|the client application of the VP web services|
21 18 chin-yeh
|vp-test|1.0.3-SNAPSHOT|the demo application for *vp-client*|
22 17 chin-yeh
|vp-batch|HEAD tag|the batch program|
23 8 chin-yeh
24
where *version* refer to:
25
* *SNAPSHOT* - for development environment
26
* *RELEASE* - for production environment
27 4 chin-yeh
28
h2. Compile from source files
29
30 20 chin-yeh
*Important Note:*
31
> This section is not applicable to *vp-batch* as its deployment files have to be compiled individually and only upload those which are needed.
32
33 4 chin-yeh
All of the projects are built and maintained using "Maven 2":http://maven.apache.org/. 
34
> Those projects can be imported into *Eclipse IDE* but the *m2 Maven* plugin is needed.
35
36
The source files are stored in:
37
> [[wiki#scm|SCM]]
38
39
*Prerequisite:*
40
* Eclipse IDE (optional)
41
* Apache Maven 2
42
* CVS client, e.g TortoiseCVS, Eclipse IDE
43 11 chin-yeh
* Project or module name, e.g. vp-client
44 1 chin-yeh
45 11 chin-yeh
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.
46 10 chin-yeh
47 11 chin-yeh
*Steps:*
48
# checkout the project or module using the CVS client
49
# <code>cd</code> to the checkout folder, e.g. vp-client
50
** *Example:*
51 4 chin-yeh
<pre>
52 1 chin-yeh
$ cd vp-client
53 4 chin-yeh
</pre>
54
# execute the maven goal, *clean* and *package*:
55 19 chin-yeh
** compile for *development* environment:
56
*** change the artifact version to *x.x-SNAPSHOT*
57 5 chin-yeh
<pre>
58
$ mvn clean package
59
</pre>
60
** compile for *production* environment:
61 12 chin-yeh
*** change the artifact version to *x.x-RELEASE*
62
<pre>
63
$ mvn -P prod clean package
64 15 chin-yeh
</pre>
65
# if success, the binary file can be found in the *target* folder