Skip to content

Commit be910ec

Browse files
author
Kendar
committed
Added quick start link
1 parent 9ec82b9 commit be910ec

File tree

3 files changed

+81
-42
lines changed

3 files changed

+81
-42
lines changed

‎CONTRIBUTING.md‎

Lines changed: 79 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,79 @@
1-
If you want to contribute just make your pull request
2-
with a description of the problem solved and the explanation
3-
of the reasons of the implementation inside the docs/contribute folder.
4-
5-
Just create a Markdown file with your github userid. To give an example
6-
i would create a docs/contribute/kendarorg.md file with all the
7-
explanations!
8-
9-
Please-please add unit tests when possible! If it's getting too hard we
10-
can open an issue and refactor!
11-
12-
Feel free!
13-
14-
## Jacoco
15-
16-
When adding a module should change the pom from jacoco adding the
17-
following parts (e.g with MYMODULE name and ORG.MYMODULE base package)
18-
19-
<report>
20-
<executiondata>
21-
...
22-
<fileset dir="${basedir}/../MYMODULE/target">
23-
<include name="jacoco*.exec" />
24-
</fileset>
25-
...
26-
</executiondata>
27-
<structure name="Integration Tests Coverage Report">
28-
<sourcefiles encoding="UTF-8">
29-
...
30-
<dirset dir="${basedir}/../MYMODULE">
31-
<include name="**/src/main/java" />
32-
</dirset>
33-
...
34-
</sourcefiles>
35-
<classfiles>
36-
...
37-
<fileset dir="${basedir}/../MYMODULE/target/classes">
38-
<include name="ORG/MYMODULE/**/*" />
39-
</fileset>
40-
...
41-
</classfiles>
42-
</structure>
1+
## Project structure
2+
3+
The whole project is composed by
4+
5+
* ham: The base implementation
6+
* globaltest: This will be run through globaltest.sh/bat. Used to verify the correctness of the -WHOLE- system
7+
* samples: Sample projects
8+
* docker: base docker images
9+
* scripts: all the scripts to run examples, test, build, release and deploy
10+
11+
## Setup
12+
13+
* Install Chrome browser
14+
* Install docker
15+
* If on linux enable java to run on low ports
16+
17+
sudo setcap CAP_NET_BIND_SERVICE=+eip [YOUR bin/JAVA]
18+
19+
### Ham
20+
21+
This is the main project
22+
23+
The tests are mostly in the API parts, they run a local version of ham
24+
25+
### Globaltest
26+
27+
This is used to
28+
29+
* Two ways to prepare
30+
* Run globaltest.sh/bat
31+
* Run the scripts/build/build_release and scripts/build/build_release_samples then extract in place the two tgz to obtain ham, calendar etc under release
32+
* Then you can run the selenium tests
33+
34+
## Pull requests
35+
36+
If you want to contribute just make your pull request
37+
with a description of the problem solved and the explanation
38+
of the reasons of the implementation inside the docs/contribute folder.
39+
40+
Just create a Markdown file with your github userid. To give an example
41+
i would create a docs/contribute/kendarorg.md file with all the
42+
explanations!
43+
44+
Please-please add unit tests when possible! If it's getting too hard we
45+
can open an issue and refactor!
46+
47+
Feel free!
48+
49+
50+
51+
## Jacoco
52+
53+
When adding a module should change the pom from jacoco adding the
54+
following parts (e.g with MYMODULE name and ORG.MYMODULE base package)
55+
56+
<report>
57+
<executiondata>
58+
...
59+
<fileset dir="${basedir}/../MYMODULE/target">
60+
<include name="jacoco*.exec" />
61+
</fileset>
62+
...
63+
</executiondata>
64+
<structure name="Integration Tests Coverage Report">
65+
<sourcefiles encoding="UTF-8">
66+
...
67+
<dirset dir="${basedir}/../MYMODULE">
68+
<include name="**/src/main/java" />
69+
</dirset>
70+
...
71+
</sourcefiles>
72+
<classfiles>
73+
...
74+
<fileset dir="${basedir}/../MYMODULE/target/classes">
75+
<include name="ORG/MYMODULE/**/*" />
76+
</fileset>
77+
...
78+
</classfiles>
79+
</structure>

‎docs/gen_scripts/quickstart.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11

2+
* Install Java 11
23
* Start locally HAM server
34
* Connect to it through proxy
45

‎docs/generated/quickstart.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
<!--This file is autogenerated. Do not edit!-->
33
In this demo you will
44

5+
* Install Java 11
56
* Start locally HAM server
67
* Connect to it through proxy
78

0 commit comments

Comments
 (0)