Documentation » History » Version 10
chin-yeh, 08/15/2011 10:31 AM
| 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 | 9 | chin-yeh | |vp-client|1.0.2-[version]|the client application of the VP web services| |
| 10 | |vp-test|1.0.2-[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 | |||
| 30 | 10 | chin-yeh | All of the project is configured to include *development properties files* when packaging the binary file. To include production properties files, refer to the following sections. |
| 31 | |||
| 32 | |||
| 33 | 4 | chin-yeh | h3. vp-stub |
| 34 | |||
| 35 | # checkout the project *vp-stub* from CVS |
||
| 36 | # <code>cd</code> to the folder: |
||
| 37 | <pre> |
||
| 38 | $ cd vp-stub |
||
| 39 | </pre> |
||
| 40 | # execute the maven goal, *clean* and *package*: |
||
| 41 | 10 | chin-yeh | ** for *development* environment: |
| 42 | 4 | chin-yeh | <pre> |
| 43 | 1 | chin-yeh | $ mvn clean package |
| 44 | </pre> |
||
| 45 | 10 | chin-yeh | ** for *production* environment: |
| 46 | 1 | chin-yeh | <pre> |
| 47 | 10 | chin-yeh | $ mvn -P prod clean package |
| 48 | 1 | chin-yeh | </pre> |
| 49 | 10 | chin-yeh | # if success, the binary file can be found in the *target* folder |
| 50 | 4 | chin-yeh | |
| 51 | 10 | chin-yeh | |
| 52 | 4 | chin-yeh | h3. vp-client |
| 53 | |||
| 54 | # checkout the project *vp-client* from cvs |
||
| 55 | # <code>cd</code> to the folder: |
||
| 56 | <pre> |
||
| 57 | 1 | chin-yeh | $ cd vp-client |
| 58 | 4 | chin-yeh | </pre> |
| 59 | # execute the maven goal, *clean* and *package*: |
||
| 60 | 10 | chin-yeh | ** for *development* environment: |
| 61 | 1 | chin-yeh | <pre> |
| 62 | $ mvn clean package |
||
| 63 | </pre> |
||
| 64 | 10 | chin-yeh | ** for *production* environment: |
| 65 | <pre> |
||
| 66 | $ mvn -P prod clean package |
||
| 67 | </pre> |
||
| 68 | 1 | chin-yeh | # if success, the binary file can be found in the *target* folder |
| 69 | 10 | chin-yeh | |
| 70 | h3. vp-batch |
||
| 71 | |||
| 72 | # checkout the project *vp-batch* from CVS |
||
| 73 | # <code>cd</code> to the folder: |
||
| 74 | 1 | chin-yeh | <pre> |
| 75 | 10 | chin-yeh | $ cd vp-batch |
| 76 | 1 | chin-yeh | </pre> |
| 77 | 10 | chin-yeh | # execute the maven goal, *clean* and *package*: |
| 78 | ** for *development* environment: |
||
| 79 | <pre> |
||
| 80 | $ mvn clean package |
||
| 81 | </pre> |
||
| 82 | ** for *production* environment: |
||
| 83 | <pre> |
||
| 84 | $ mvn -P prod clean package |
||
| 85 | </pre> |
||
| 86 | # if success, the binary file can be found in the *target* folder |
||
| 87 | |||
| 88 | |||
| 89 | 5 | chin-yeh | |
| 90 | h2. Programming Guide |
||
| 91 | |||
| 92 | See [[Programming Guide]] |