Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tyler36/ddev-qr
Helper command to generate qr-codes for DDEV, DDEV share and Gitpod URLs
https://github.com/tyler36/ddev-qr
ddev ddev-get qrcode qrcode-generator
Last synced: 14 days ago
JSON representation
Helper command to generate qr-codes for DDEV, DDEV share and Gitpod URLs
- Host: GitHub
- URL: https://github.com/tyler36/ddev-qr
- Owner: tyler36
- License: apache-2.0
- Created: 2024-06-21T02:13:53.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-01-06T04:33:26.000Z (16 days ago)
- Last Synced: 2025-01-06T05:25:16.885Z (16 days ago)
- Topics: ddev, ddev-get, qrcode, qrcode-generator
- Language: Shell
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/tyler36/ddev-qr/actions/workflows/tests.yml) 
# DDEV-QR
- [Introduction](#introduction)
- [Getting started](#getting-started)
- [Usage](#usage)
- [What's a QR code?](#whats-a-qr-code)
- [Why do I want to use it?](#why-do-i-want-to-use-it)
- [Components of the repository](#components-of-the-repository)
- [Contributing](#contributing)
## Introduction
DDEV-QR is a DDEV add-on that encodes DDEV URLs into [QR codes](#whats-a-qr-code).
It uses [qrencode](https://fukuchi.org/works/qrencode/) to parse a URL string into a QR code that is displayed in the terminal.
This helps reduce errors and frustration when entering URLs on portable devices.
## Getting started
1. Install the app.
For DDEV v1.23.5 or above run
```shell
ddev add-on get tyler36/ddev-qr
```
For earlier versions of DDEV run
```shell
ddev get tyler36/ddev-qr
```
Then restart your project
```shell
ddev restart
```
## Usage
This add-on add a new command, `qr` that will generate a QR code as follows:
- `ddev qr`: Encodes the primary website. Eg. . Shorthand for `ddev qr https`.
- `ddev qr https`: Encodes the HTTPS version of the primary website. Eg. .
- `ddev qr http`: Encodes the HTTP version of the primary website. Eg. .
- `ddev qr share`: Tries to find the share tunnel and encodes the random address.
- `ddev qr _STRING_`: Encodes the value of `_STRING_`.
Note: Using `ddev qr` or `ddev qr https` inside a Gitpod environment will encode the Gitpod-routed DDEV URL instead.
## What's a QR code?
A QR code is a two-dimensional barcode that can store a string of information such as a URL.
You can use a QR reader, such as the camera in you mobile phone, to read the image. In the case of a URL, a mobile phone can then visit the URL.
Below is QR code with encoded.
See [Scan QR codes on Camera from Google](https://support.google.com/camerafromgoogle/answer/12033278?hl=en).
See [Scan a QR code with your iPhone, iPad, or iPod touch](https://support.apple.com/en-us/102680).
## Why do I want to use it?
Initially, this addon was created for use with `ddev share` which (currently) uses ngrok.
When using the free tier service, ngrok generates a random string address to access your website:
Eg.
This is great but it's not so fun typing that string on a small keyboard.
Instead:
- Use DDEV to share the site: `ddev share`
- Generate a qr code: `ddev qr share`
- Scan with code with your phone to visit the site.
Similar, when using DDEV in Gitpod, DDEV defers to Gitpod's routing system that also generates random complex strings.
Using `ddev qr` or `ddev qr https` inside a Gitpod environment will encode the Gitpod-routed DDEV URL instead. Eg.
## Components of the repository
- `commands/host/qr`: A helper command to interact with the encoder.
- `Dockerfile.qrencode`: Docker file that installs `qrencode` inside the web container.
## Contributing
PR are welcome, especially if they contain working tests.
**Contributed and maintained by [@tyler36](https://github.com/tyler36)**