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