Corona-Warn-App: cwa-event-qr-code

About this Repository

Utility to generate QR codes for Event Registration (incl. from the CLI). For information about the project, please see our documentation repository.

Remark: This utility is in early stages of development and should help you to create multiple QR codes at once. If you find this useful or you identified a bug, feel free to create an issue.

Requirements

You need version 14 (LTS) or higher of Node.js (which includes npm) to use this utility.

CLI Usage

Installation and Basics

# Option a) Install globally to make executable available
$ npm install cwa-event-qr-code --global
$ cwa-event-qr-code --help
$ cwa-event-qr-code --version

# Option b) Use npx and skip the installation
$ npx cwa-event-qr-code --help
$ npx cwa-event-qr-code --version

Create Posters

# Multiple posters from CSV
$ cwa-event-qr-code poster \
  --csv examples/sample-data.csv \
  --dest posters

# Single poster from arguments
$ cwa-event-qr-code poster \
  --description "Some Bakery" \
  --address "Some Street, Some City" \
  --type 4 \
  --default-check-in-length-in-minutes 15 \
  --filepath bakery.pdf

Create QR codes only

# Multiple QR codes from CSV
$ cwa-event-qr-code file \
  --csv examples/sample-data.csv \
  --dest qr-codes

# Single QR code from arguments (as PNG)
$ cwa-event-qr-code file \
  --description "Some Bakery" \
  --address "Some Street, Some City" \
  --type 4 \
  --default-check-in-length-in-minutes 15 \
  --filepath bakery.png

# Single QR code from arguments (as SVG)
$ cwa-event-qr-code file \
  --description "Some Bakery" \
  --address "Some Street, Some City" \
  --type 4 \
  --default-check-in-length-in-minutes 15 \
  --filepath bakery.svg

Usage in Node.js

Install as a dependency:

$ npm install cwa-event-qr-code

Then use it in your script:

const { createEventQRCode } = require('cwa-event-qr-code')

const eventQRCode = createEventQRCode({
  locationData: {
    description: 'hello-world',
    address: 'hello'
  },
  vendorData: {
    type: 1,
    defaultCheckInLengthInMinutes: 30
  }
})

// Create a PNG
await eventQRCode.toPNG('hello-world.png')

// Get just the url
const url = await eventQRCode.toURL()

Documentation

The full documentation for the Corona-Warn-App can be found in the cwa-documentation repository. The documentation repository contains technical documents, architecture information, and white papers related to this implementation.

Support and Feedback

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

| Type | Channel | | ------------------------ | ------------------------------------------------------ | | General discussion, issues, bugs | | | Other requests | |

How to contribute

The German government has asked SAP and Deutsche Telekom AG to develop the Corona-Warn-App for Germany as open source software. Deutsche Telekom is providing the network and mobile technology and will operate and run the backend for the app in a safe, scalable and stable manner. SAP is responsible for the app development, its framework and the underlying platform. Therefore, development teams of SAP and Deutsche Telekom are contributing to this project. At the same time 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.

For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. By participating in this project, you agree to abide by its Code of Conduct at all times.

Repositories

A list of all public repositories from the Corona-Warn-App can be found here.

Licensing

Copyright (c) 2020-2021 Deutsche Telekom AG and SAP SE or an SAP affiliate company.

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.

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 for the specific language governing permissions and limitations under the License.

The "Corona-Warn-App" logo is a registered trademark of The Press and Information Office of the Federal Government. For more information please see bundesregierung.de.