README.md 3.85 KB
Newer Older
Daniel Eder's avatar
Daniel Eder committed
1
<h1 align="center">
Daniel Eder's avatar
Daniel Eder committed
2
    EU Digital COVID Certificate Issuance Web Frontend
Daniel Eder's avatar
Daniel Eder committed
3
4
5
6
7
8
9
10
11
</h1>

<p align="center">
    <a href="/../../commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/eu-digital-green-certificates/dgca-issuance-web?style=flat"></a>
    <a href="/../../issues" title="Open Issues"><img src="https://img.shields.io/github/issues/eu-digital-green-certificates/dgca-issuance-web?style=flat"></a>
    <a href="./LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=flat"></a>
</p>

<p align="center">
Daniel Eder's avatar
Daniel Eder committed
12
  <a href="#about">About</a>
Daniel Eder's avatar
Daniel Eder committed
13
14
15
16
17
18
19
  <a href="#development">Development</a>
  <a href="#support-and-feedback">Support</a>
  <a href="#how-to-contribute">Contribute</a>
  <a href="#contributors">Contributors</a>
  <a href="#licensing">Licensing</a>
</p>

Daniel Eder's avatar
Daniel Eder committed
20
21
## About

Daniel Eder's avatar
Daniel Eder committed
22
This repository contains the source code of the EU Digital COVID Certificate Issuance Web Frontend.
Daniel Eder's avatar
Daniel Eder committed
23

24
25
26
The issuer application frontend provides a user interface that is used by the issuer to enter the necessary data for DGC issuance.

The system is based on EU-Guidelines for the [EU digital green certificates](https://ec.europa.eu/info/live-work-travel-eu/coronavirus-response/safe-covid-19-vaccines-europeans/covid-19-digital-green-certificates_en).
Daniel Eder's avatar
Daniel Eder committed
27
28
29
30

## Development

### Prerequisites
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
- [ ] [Git](https://git-scm.com/)
- [ ] [Node.js](https://nodejs.org/en/download/) (which comes with [npm](https://www.npmjs.com/))
- [ ] [yarn](https://yarnpkg.com/) (recommended)

### How to use
We recommend to use yarn to install and run the project. However the npm package manager can also be used.

#### Getting the source code
```
# Clone this repository
$ git clone https://github.com/eu-digital-green-certificates/dgca-issuance-web.git

# Go into the repository
$ cd dgca-issuance-web
```

#### Starting the project (yarn)
```
ggrund-tsi's avatar
ggrund-tsi committed
49
50
51
# Install yarn
$ npm install -g yarn

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Install dependencies
$ yarn install

# Run the app
$ yarn start
```

#### Starting the project (npm)
```
# Install dependencies
$ npm install

# Run the app
$ npm run start
```
Daniel Eder's avatar
Daniel Eder committed
67
68
69
70
71
72
## Support and feedback

The following channels are available for discussions, feedback, and support requests:

| Type                     | Channel                                                |
| ------------------------ | ------------------------------------------------------ |
Daniel Eder's avatar
Daniel Eder committed
73
| **Issues**    | <a href="/../../issues" title="Open Issues"><img src="https://img.shields.io/github/issues/eu-digital-green-certificates/dgca-issuance-web?style=flat"></a>  |
Daniel Eder's avatar
Daniel Eder committed
74
| **Other requests**    | <a href="mailto:opensource@telekom.de" title="Email DGC Team"><img src="https://img.shields.io/badge/email-DGC%20team-green?logo=mail.ru&style=flat-square&logoColor=white"></a>   |
Daniel Eder's avatar
Daniel Eder committed
75

ggrund-tsi's avatar
ggrund-tsi committed
76
## How to contribute
Daniel Eder's avatar
Daniel Eder committed
77
78
79

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.

ggrund-tsi's avatar
ggrund-tsi committed
80
## Contributors
Daniel Eder's avatar
Daniel Eder committed
81
82
83
84
85
86
87
88
89
90
91

Our commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.

## Licensing

Copyright (C) 2021 T-Systems International GmbH and all other contributors

Licensed under the **Apache License, Version 2.0** (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

ggrund-tsi's avatar
ggrund-tsi committed
92
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the [LICENSE](./LICENSE) for the specific language governing permissions and limitations under the License.