Project

General

Profile

How to run a sample » History » Version 14

Henning Blohm, 11.09.2012 15:38

1 1 Henning Blohm
h1. How to Run a Sample
2
3
Various z2-based sample system configurations have been prepared as Git repositories. 
4
5 14 Henning Blohm
Assuming you know the repository URL these three steps (with or without Eclipse) are all there is to do: 
6
7
h1. Eclipse users
8
9
Most likely you also want to look at code or configuration files of an example. That is why we recommend to start from within the Eclipse IDE. If you prefer the command line or another IDE, please proceed to 
10
11
12
h1. From the Command Line
13
14
{{macro_list}}
15 1 Henning Blohm
16 2 Henning Blohm
h2. 0. Pre-Requisites
17
18
All you need is Java Runtime Environment (JRE) of at least version 6. Preferrably, as that is easier to understand a sample, have the Eclipse IDE installed.
19 3 Henning Blohm
Other pre-requisites, for example some database setup may be required based on the specific example, i.e. stuff that cannot be covered here.
20 2 Henning Blohm
21 1 Henning Blohm
h2. 1. Prepare a z2-base Installation
22 2 Henning Blohm
23
Create a folder to hold the installation. We will assume that folder is called *sample*
24
25
In *sample* execute
26
27 11 Henning Blohm
<pre>
28 5 Henning Blohm
git clone -b master http://git.z2-environment.net/z2-base.core
29 11 Henning Blohm
</pre>
30 2 Henning Blohm
31
Go into *sample/z2-base.core/run/bin* and run 
32
33
<pre>
34
./gui.sh
35
</pre>
36
37
or 
38
39
<pre>
40
gui.bat
41
</pre>
42 1 Henning Blohm
43 3 Henning Blohm
depending on your operating system. A simple graphical console should open up that displays the console log output of the z2 &lt;home&gt; and worker processes - as explained in http://www.z2-environment.eu/check_it_out.
44 2 Henning Blohm
45
At the first start, the environment will download required resources, which may take a few minutes - depending on your network bandwidth. Subsequent starts will be faster.
46
Eventually the server should be up and you can go to the basic admin view at http://localhost:8080/adm (use z* with password z) to verify everything is cool.
47 1 Henning Blohm
48 6 Henning Blohm
Stop the environment again by either pressing Ctrl+C on the console where you started the GUI or by clicking the Exit button on the GUI.
49 1 Henning Blohm
50 3 Henning Blohm
h2. 2. Clone the specific sample repository
51 1 Henning Blohm
52 3 Henning Blohm
Given the sample repository is called *z2-samples.sampleX*, go into *sample* once more and run 
53 1 Henning Blohm
54 3 Henning Blohm
<pre>
55 5 Henning Blohm
git clone -b master http://git.z2-environment.net/z2-samples.sampleX
56 3 Henning Blohm
</pre>
57
58
Now start the environment as described above. The environment will now run with the sample configuration and all required dependencies.
59
60 4 Henning Blohm
In other words: That's it.
61
62 3 Henning Blohm
h2. Why does that actually work
63
64
If you care, here is how everything falls into place:
65
66 13 Henning Blohm
The z2-base.core repository contains a z2 core installation that is bound to a remote "system repository" at "http://git.z2-environment.net/z2-base.base":http://redmine.z2-environment.net/projects/z2-base/repository/base?rev=master. As it is by now best practice with z2, that repository contains an *environment* module that describes system specific settings such as other repositories.
67 3 Henning Blohm
68
By cloning the sample repository you put an override of *environment* module into view of the _dev repository_. That is, the local server will take your local definitions with preference over the remote definitions. These may include other remote component repositories such as *z2-addons.spring*.
69
70
In addition the sample repository contains all the modules holding code and other resources that implement the actual sample.
71
72
If you already understand how the _dev repository_ works, you will not be surprised to find files called LOCAL in the module folders of cloned repository's workspace.
73
74
h2. References
75
76
* Dev Repository: http://www.z2-environment.eu/v20doc#Workspace%20Development%20Using%20the%20Dev%20Repository