https://github.com/rishabkumar7/azure-qr-code

Serverless Azure Function that generates QR codes for provided URLs and stores them in Azure Blob Storage.
https://github.com/rishabkumar7/azure-qr-code

azure-functions nextjs node nodejs serverless

Last synced: 2 days ago
JSON representation

Serverless Azure Function that generates QR codes for provided URLs and stores them in Azure Blob Storage.

• Host: GitHub
• URL: https://github.com/rishabkumar7/azure-qr-code
• Owner: rishabkumar7
• License: mit
• Created: 2023-12-07T03:58:11.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-16T03:30:53.000Z (8 months ago)
• Last Synced: 2024-05-08T00:27:13.341Z (6 months ago)
• Topics: azure-functions, nextjs, node, nodejs, serverless
• Language: JavaScript
• Homepage: https://url-qr-code.azurewebsites.net
• Size: 688 KB
• Stars: 2
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Azure QR Code Generator

[![Build and deploy](https://github.com/rishabkumar7/azure-qr-code/actions/workflows/main_qr-code-generator7.yml/badge.svg)](https://github.com/rishabkumar7/azure-qr-code/actions/workflows/main_qr-code-generator7.yml)

This repository contains the code for serverless Azure Function that generates QR codes for provided URLs and stores them in Azure Blob Storage. The function is written in JavaScript and can be triggered via HTTP requests.

## Demo

Send a `GET` request to the Azure Function `https://azure-qr-code.azurewebsites.net/api/GenerateQRCode` with `url` as parameter.

`curl` example:

``` bash

curl -X GET https://azure-qr-code.azurewebsites.net/api/GenerateQRCode -H "Content-Type: application/json" -d '{"url":"https://www.example.com"}'

```

Postman example:

![Azure QR Code Generator GIF Postman Example](./assets/azure-qr-code.gif)

## Architecture

![Azure QR Code Generator Architecture](./assets/azure-qr-code-architecture.png)

## Features

-   **Serverless**: Leverages Azure Functions for minimal infrastructure management.

-   **QR Code Generation**: Dynamically creates QR codes for any given URL.

-   **Azure Blob Storage**: Stores the generated QR codes in the cloud for easy access and management.

## Prerequisites

-   [Node.js](https://nodejs.org/)

-   [Azure Functions Core Tools](https://learn.microsoft.com/en-us/azure/azure-functions/functions-run-local?tabs=linux%2Cisolated-process%2Cnode-v4%2Cpython-v2%2Chttp-trigger%2Ccontainer-apps&pivots=programming-language-csharp)

-   Azure CLI

-   An Azure account and an Azure Blob Storage account.

## Getting Started

### 1. Clone the Repository

``` bash

git clone https://github.com/rishabkumar7//azure-qr-code.git

cd azure-qr-code/qrCodeGenerator

```

### 2. Install Dependencies

```bash

npm install

```

### 3. Local Configuration

Set up your `local.settings.json` file with the necessary configuration values:

```json

{

    "IsEncrypted": false,

    "Values": {

        "AzureWebJobsStorage": "",

        "FUNCTIONS_WORKER_RUNTIME": "node",

	      "STORAGE_CONNECTION_STRING":""

    }

}

```

### 4. Running Locally

To start the function app locally, make sure you have Azure Functions Core Tools installed, then run:

```bash

func start

```

### 5. Deploy to Azure

Deploy your function app to Azure using the following command:

```bash

func azure functionapp publish 

```

## Usage

Send a `GET` request to your function's endpoint with a JSON payload containing the URL:

`curl -X GET https:///api/GenerateQRCode -H "Content-Type: application/json" -d '{"url":"https://www.example.com"}'`

## Author

- Twitter: [@rishabincloud](https://twitter.com/rishabincloud)

- GitHub: [@rishabkumar7](https://github.com/rishabkumar7)