cloudengine-labs/linktoqr

Code in this repo will help to generate QR from the given URL

Convert URL link to QR Code

ToDo

• Contenerisation using Dockerfile
• GitHub workflow for CI
• Unit Tests
• GitHub workflow for CD (implemented k8s deployment in minikube)
• Add GitHub Action container registry upload

Purpose

Code in this repo will help to generate QR from the given URL.

Read before you start contributing to this repo

• Read Contribution Guidelines before contributing to this repository!

• Read GitHub Code Of Conduct guidelinesbefore contributing to this repository!

• Feel free to pick up any of the open Issues or create new issue using the template!

• This repo also has GitHub action Terraform AWS workflow to check the Terraform AWS resource code is valid and works fine. Please utilize it for checking-in the code you're pushing passes the check creating. All you've to do is,

  • Open Workflow in "Actions" Tab
  • Check if the workflow is passing or not. Fix the issue in case of failure.

Installation methods

Method 1: Install from the github path

• Run the command below to install the executable

mkdir -p ~/go/bin && go install github.com/chefgs/linktoqr@latest

How to run the executable

• The executable will be stored in ~/go/bin path
• Go to ~/go/bin path to execute the Go executable file or add the ~/go/bin directory to PATH environment variable, so the executable can be accessed anywhere from terminal path or command prompt
• Run the below commands

cd ~/go/bin
./linktoqr

Method 2: Docker image execution

• The executable has been built inside a Docker image and is available to pull from Docker hub registry gsdockit/linktoqr:latest
• Run the below command to run the QR converter using docker

docker run -d -p 1718:1718 gsdockit/linktoqr

• Rest of the steps for accessing the QR via browser is same, and can be accessed via http://localhost:1718

Method 3: GitHub package Docker image execution

• The executable has been built inside a Docker image and is available to pull from Docker hub registry gsdockit/linktoqr:latest
• Run the below command to run the QR converter using docker

docker run -d -p 1718:1718 ghcr.io/chefgs/linktoqr:latest

Access to QR generator portal

• Once we execute the code, it will run the portal in localhost port 1718
• So access the QR generator portal by accessing it from http://localhost:1718
• Enter the URL in the text box

• Click Show QR button
• Now, you can see the QR code for the entered URL.

• You can save this image as .png file and use it where ever you want.

Reference

This repo code has been inspired from the example in Effective Go Docs page.