Code Monkey home page Code Monkey logo

cwa-event-qr-code's Introduction


Build Status

About this RepositoryRequirementsCLI UsageUsage in Node.jsDocumentationSupport and FeedbackHow to contributeLicensingWeb Site


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.

Usage Guide

A step by step explanation on how to use this tool is available here, on our website.

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()

Debug local changes

# Run the CLI-Tool locally
$ node bin/cli file \
  --description "Some Bakery" \
  --address "Some Street, Some City" \
  --type 4 \
  --default-check-in-length-in-minutes 15 \
  --filepath bakery.png

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

cwa-event-qr-code's People

Contributors

christianneu avatar crystalskulls avatar dependabot[bot] avatar dsarkar avatar ein-tim avatar mlenkeit avatar tuxbox avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cwa-event-qr-code's Issues

Support poster/PDF creation

The tool currently only allows to generate the QR code directly, but not the poster around it.

It would be great if the tool would also support generating a PDF or SVG.

CWA trademark usage for compatibility indication

Hi!

I hope this is a good place to ask this since this repo promotes the integration of event-qr-code generation into third-party applications for people who host lots of events.

The QR code generation integrated in the Android app creates a printable version including the logos of CWA and the Bundesregierung.

If QR codes are integrated by a third-party application, is would be desireable to use the CWA logo as well to show people quickly that it's a CWA-compatible QR code.

The README makes clear that the CWA logo is not covered by the open source license, but is a trademark of the Bundesregierung. Would such usage considered to be okay? Is the press office linked in the README really the correct point of contact if this repo isn't?


Internal Tracking ID: EXPOSUREAPP-6744

Start time can be after end time

Describe the bug

You can create an qr code with the start date after the end date.

Expected behaviour

Throw an error

Steps to reproduce the issue

Technical details

  • Host Machine OS (Windows/Linux/Mac): macOS 11.2.3 Safari & Firefox 87

Possible Fix

Additional context

possibility for external Websites to create an QR Code automatically

Current Implementation

an batch creation (#2) is planned. But there is no way for external websites to create an QR Code automatically on their site

Suggested Enhancement

My parish is using www.evangelische-termine.de as a calender. It would be great, if there would be a possibility for calendar/planning sites to offer a CWA QR-Code for each date. The necessary data is already existing.

Expected Benefits

It would make it much easier for external sites to use the CWA QR Code

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.