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