You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 16, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+21-21
Original file line number
Diff line number
Diff line change
@@ -23,12 +23,12 @@ The goal of this project is to develop the official Corona-Warn-App for Germany
23
23
## Architecture Overview
24
24
You can find an architectural overview of the component in the [solution architecture document](https://github.com/corona-warn-app/cwa-documentation/blob/master/solution_architecture.md)
25
25
This component of the Corona-warn-app whereas named **verification process** provides indeed two functionalities:
26
-
1. prove that a prentended positive case is indeed positive
26
+
1. prove that a pretended positive case is indeed positive
27
27
2. provide the result of a Covid-19 Test
28
28
29
-
To achieve this, the verification service gets the result of covid-19 tests from LIS (**L**abor **I**nformation **S**ystem) which deliver testresults to it. The complete process is described in [cwa-documentation/Solution Architecture](https://github.com/corona-warn-app/cwa-documentation/blob/master/solution_architecture.md) to which you may refer for detailed information about the workflow.
29
+
To achieve this, the verification service gets the result of covid-19 tests from LIS (**L**abor **I**nformation **S**ystem) which deliver test results to it. The complete process is described in [cwa-documentation/Solution Architecture](https://github.com/corona-warn-app/cwa-documentation/blob/master/solution_architecture.md) to which you may refer for detailed information about the workflow.
30
30
31
-
The software stack of the verification server is based on spring boot, currently with an in-memory H2 database. As the persistence relies on the liquibase
31
+
The software stack of the verification server is based on spring boot, currently with an in-memory H2 database. As the persistence relies on the liquibase.
32
32
33
33
34
34
## Development
@@ -42,12 +42,12 @@ There are two ways to build:
42
42
[Maven](https://apache.maven.org)
43
43
*(optional)*: [Docker](https://www.docker.com)
44
44
### Build
45
-
Whether you cloned or downloaded the 'ziped' souces you will either find the sources in the chosen checkout-directory or get a zip file with the source code, which you can expand to a folder of your choice.
45
+
Whether you cloned or downloaded the 'zipped' sources you will either find the sources in the chosen checkout-directory or get a zip file with the source code, which you can expand to a folder of your choice.
46
46
47
-
In either case open a terminal pointing to the directory you put the sources in. The local build process is described afterwards depending on the way you chose.
47
+
In either case open a terminal pointing to the directory you put the sources in. The local build process is described afterwards depending on the way you choose.
48
48
#### Maven based build
49
-
For acitvely take part on the development this is the way you should chose.
50
-
Please check, whether following prerequisites are fullfilled
49
+
For actively take part on the development this is the way you should choose.
50
+
Please check, whether following prerequisites are fulfilled
51
51
-[Open JDK 11](https://openjdk.java.net) or a similar JDK 11 compatible VM
52
52
-[Maven](https://apache.maven.org)
53
53
@@ -60,26 +60,26 @@ You can then open a terminal pointing to the root directory of the verification
60
60
The verification server will start up and run locally on your machine available on port 8080.
61
61
62
62
#### Docker based build
63
-
We recommend, that you first check the prerequisites to ensure that
63
+
We recommend that you first check the prerequisites to ensure that
64
64
-[Docker](https://www.docker.com)
65
65
66
-
is istalled on you machine
66
+
is installed on you machine
67
67
68
68
On the commandline do the following:
69
-
70
-
docker build -f|--file <path to dockerfile> -t <imagename> <path-to-verificationserver-root>
71
-
docker run -p 127.0.0.1:8080:8080/tcp -it <imagename>
72
-
69
+
```bash
70
+
docker build -f|--file <path to dockerfile> -t <imagename><path-to-verificationserver-root>
71
+
docker run -p 127.0.0.1:8080:8080/tcp -it <imagename>
docker run -p 127.0.0.1:8080:8080/tcp -it cwa-verificationserver
77
+
```
78
78
if you are in the root of the checked out repository.
79
-
The dockerimmage will then run on your local machine on port 8080 assuming you configured docker for shared network mode.
79
+
The docker image will then run on your local machine on port 8080 assuming you configured docker for shared network mode.
80
80
#### API Documentation
81
81
82
-
Along with the application there comes a swagger2 api documentation which you can access in your webbrowser, when the verification server applications runs:
82
+
Along with the application there comes a swagger2 api documentation which you can access in your web browser, when the verification server applications runs:
This repository contains files which support our CI/CD pipeline and will be remove without further notice
94
-
- DockerfileCi - used for the GitHub buildchaing
94
+
- DockerfileCi - used for the GitHub build chain
95
95
- Jenkinsfile - used for Telekom internal SBS (**S**oftware**B**uild**S**ervice)
96
96
97
97
@@ -112,7 +112,7 @@ The following channels are available for discussions, feedback, and support requ
112
112
113
113
## How to Contribute
114
114
115
-
Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](./CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times.
115
+
Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](./CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times.
0 commit comments