Skip to content
This repository was archived by the owner on May 16, 2023. It is now read-only.

Commit 86764b6

Browse files
author
telekom
committed
fix: documentation
1 parent b8dbfea commit 86764b6

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

README.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ The goal of this project is to develop the official Corona-Warn-App for Germany
2323
## Architecture Overview
2424
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)
2525
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
2727
2. provide the result of a Covid-19 Test
2828

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.
3030

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.
3232

3333

3434
## Development
@@ -42,12 +42,12 @@ There are two ways to build:
4242
[Maven](https://apache.maven.org)
4343
*(optional)*: [Docker](https://www.docker.com)
4444
### 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.
4646

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.
4848
#### 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
5151
- [Open JDK 11](https://openjdk.java.net) or a similar JDK 11 compatible VM
5252
- [Maven](https://apache.maven.org)
5353

@@ -60,26 +60,26 @@ You can then open a terminal pointing to the root directory of the verification
6060
The verification server will start up and run locally on your machine available on port 8080.
6161

6262
#### 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
6464
- [Docker](https://www.docker.com)
6565

66-
is istalled on you machine
66+
is installed on you machine
6767

6868
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>
72+
```
7373
or simply
74-
75-
docker build --pull --rm -f "Dockerfile" -t cwa-verificationserver "."
76-
docker run -p 127.0.0.1:8080:8080/tcp -it cwa-verificationserver
77-
74+
```bash
75+
docker build --pull --rm -f "Dockerfile" -t cwa-verificationserver "."
76+
docker run -p 127.0.0.1:8080:8080/tcp -it cwa-verificationserver
77+
```
7878
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.
8080
#### API Documentation
8181

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:
8383

8484
<base-url>/swagger-ui.html#/verification-controller
8585

@@ -91,7 +91,7 @@ http://localhost:8080/swagger-ui.html#/verification-controller
9191

9292
#### Remarks
9393
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
9595
- Jenkinsfile - used for Telekom internal SBS (**S**oftware**B**uild**S**ervice)
9696

9797

@@ -112,7 +112,7 @@ The following channels are available for discussions, feedback, and support requ
112112

113113
## How to Contribute
114114

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.
116116

117117
## Contributors
118118

THIRD-PARTY-NOTICES

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ThirdPartyNotices
22
-----------------
3-
corona-warn-app/cwa-server uses third-party software or other resources that
4-
may be distributed under licenses different from corona-warn-app/cwa-server
3+
corona-warn-app/cwa-verification-server uses third-party software or other resources that
4+
may be distributed under licenses different from corona-warn-app/cwa-verification-server
55
software.
66
In the event that we overlooked to list a required notice, please bring this
77
to our attention by contacting us via this email:

0 commit comments

Comments
 (0)