Serverless function to generate QR codes

This is a simple serverless endpoint to be used to generate QR codes. The idea is that you deploy your serverless function to a cloud provider and then you can use the URL of the function to generate QR codes.

Note: protect this function with a firewall or other security measures, as serverless functions can become very easy to exploit and become extremely expensive very quickly.

Requiremenents

• Node.js 16+
• Serverless Framework

You will also need an AWS account with right permissions to deploy AWS Lambda function with Cloud Formation and API Gateway.

Local development

To run the endpoint locally, you will need to install the dependencies and run the following commands:

# install dependencies
npm install

# run the endpoint
npm run offline

Deployment

Deploy from local

To deploy the code locally, you will need to run the following commands:

npm run deploy

Deploy it with Github Actions

There's a Github Action that will deploy the code to AWS Lambda and API Gateway, so you can use it to deploy the code. You will just need to uncomment the following lines in the release.yml:

# rest of the code
steps:
  # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
  - uses: actions/checkout@v3
  - uses: actions/setup-node@v3
    with:
      node-version: 18
  - run: npm install
  # Enable this to deploy to AWS
  - name: serverless deploy
    uses: serverless/github-action@master
    with:
      args: deploy --stage production

The last four lines will deploy the code to AWS Lambda and API Gateway.

How to run it

Once the endpoint is deployed, you should be able to call the following endpoint to generate a QR code:

POST <Lambda Path>/generate

With the following payload:

{
  "url": "https://www.google.com",
  "version": 4,
  "type": "svg"
}

The version is optional and defaults to 4, and accepts a range between 1 and 40. For more info please refer to the node-qrcode official documentation. The type is also optional and defaults to svg. It accepts svg, terminal or utf8.

The output will be a image with the QR code, if you are using the endpoint via terminal, using curl, it's recommended to use either terminal or utf8 as an type. Example:

# Run in local environment
curl --location --request POST 'http://localhost:4001/production/generate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://example.com",
    "version": 4,
    "type": "utf8"
}'

    █▀▀▀▀▀█  ██   ▀█▄ ▄ ▄█ ▀▄ █▀▀▀▀▀█
    █ ███ █ █▄ ▄  ▀█  ▄  █▀ █ █ ███ █
    █ ▀▀▀ █ ██ ▀▀██▀▀█ ▄▀▄█▄▄ █ ▀▀▀ █
    ▀▀▀▀▀▀▀ █ █▄█▄▀ █▄█▄█▄▀▄▀ ▀▀▀▀▀▀▀
    ▀▄█▀▀▀▀▄ ██ █▄▀▄▄▄▄▀▄ ▀█  ██▀██▄ 
    ▄ █▀ ▄▀▀█ █ ▀█▀ ▄█▄█▄ ▀  ▄  █▄█▄ 
    ▀▀▀ ▄█▀▀▄█  ▄▄▀▄▀ ▄▀▀█▀▀▄▄ ▀▄█ ▄▄
    ██▄█ ▄▀██▀ █ ▄▀█▀ ▀ ▀██ ▄██▀█▄ ▀ 
    █▄ █▀█▀▄ █ █▀ ██▀ ▀  ▄ ▄▀▀▄█▀▄█ ▀
    ▀█▀ ▀█▀▄  █ ▄▀██▀ ▀ ██▄ ▄▀███▄█▀█
    ▄ ▄▄█▄▀█▀ ▀    █▄▄▀▀▄▀▄ ▀▀▀▄ ▀▄▀█
    █  ▄█▄▀▄ ▄██▄ █ ▄█▄█▄▄▀█▀█ ▄ ▀██▄
    ▀     ▀▀▄ █ ▄▄▀▄▄▄▄█▄ ▀▀█▀▀▀█▀█▄ 
    █▀▀▀▀▀█ ▄ ▀▄ ▄█ ▄█▄▄█ ▀██ ▀ █▄█▄ 
    █ ███ █ █▀ ▀ ▄█▄▀ ▄▀▀█▀ ██▀▀██ ▄ 
    █ ▀▀▀ █ ▀▄█▀█▄▀█▀ ▀ ▀▄▄▄▄▀▀▀▄▄   
    ▀▀▀▀▀▀▀ ▀  ▀▀ ▀▀▀ ▀   ▀ ▀▀ ▀  ▀▀ 

Remove the function

To remove the function, you will need to run the following commands:

npm run remove-app

AWS Permissions

In order to create the AWS stack with CloudFormation, you will need to either add the profile to the serverless configuration, for example:

provider:
  name: aws
  profile: ${env:AWS_PROFILE}

Or you can add the AWS credentials adding the ARN with the permissions to deploy to the serverless configuration, for example:

provider:
  name: aws
  runtime: nodejs18.x
  iam:
    role: arn:aws:iam::123456789:role/replace-this-with-your-role

For more info regarding AWS IAM, please read this documentation.

Test the application

This package uses Jest as a test runner, to run the tests you will need to run the following command:

npm test