npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lambda-resize-image

v2.2.0

Published

An AWS Lambda Function to resize images automatically with API Gateway and S3 for imagemagick tasks. When an image is called on AWS Api Gateway, this package will resize it and send it to the S3.

Downloads

51

Readme

lambda-resize-image

Build Status Codacy Badge Maintainability npm version dependencies Status devDependencies Status npm

An AWS Lambda Function to resize images automatically with API Gateway and S3 for imagemagick tasks. When an image is called on AWS Api Gateway, this package will resize it and send it to the S3.

Contents

Requirements

  • Node.js - AWS Lambda supports versions of 10.20.1 or above (Recommended: 12.X).

New version 2.0

We've changed our approache to remove redirects from our responses. Then, we are returning a binary file base 64 image file.

Steps to version 2.0

You must have AWS CLI installed to execute a command from your console:

aws apigateway update-integration-response --rest-api-id <API_ID> --resource-id <RESOURCE_ID> --http-method GET --status-code 200 --patch-operations '[{"op" : "replace", "path" : "/contentHandling", "value" : "CONVERT_TO_BINARY"}]'

In API GW -> Settings -> Binary Media Types and add:

*/*

What is it?

It's AWS Lambda, which is a compute service that lets you run code without provisioning or managing servers.

Read more about AWS Lambda.

Description

The combination of API Gateway and Lambda is very powerful. It allows you to build some complex functionalities without maintaining any virtual machines yourself. Lambda can be hooked up to many other (AWS) Services including S3. That's why I decided to build an AWS Lambda Function to resize images automatically with API Gateway and S3 for imagemagick tasks. When an image is called on AWS S3 bucket (via API Gateway), this package will resize it and send it to the S3 before redirecting you to the new path of the image (aws bucket url or CDN).

Features

Instalation

First, add Serverless globally:

npm install -g serverless

Then, clone the repository into your local environment:

git clone https://github.com/apoca/lambda-resize-image
cd lambda-resize-image
npm install

Modify and set the .env.example to env.yml with your data. (You are supposed to have already configured your local variables).

AWS credentials

To run local development you also might need to configure you aws credentials, or you can set them to what I've shown below.

Deploy to Amazon AWS

You can also check if you have everything installed in the correct way:

$ serverless

To deploy from your environment to Amazon AWS, you must:

$ serverless deploy --stage dev or $ serverless deploy --stage prod for production configurations.

Then, serverless will package, validate and upload your stack to Amazon AWS. It will probably look like this:

Serverless: Packaging service...
Serverless: Uploading CloudFormation file to S3...
Serverless: Uploading artifacts...
Serverless: Uploading service .zip file to S3 (1.52 KB)...
Serverless: Validating template...
Serverless: Updating Stack...
Serverless: Checking Stack update progress...
..............
Serverless: Stack update finished...
Service Information
service: resizeS3Image
stage: development
region: eu-west-1
stack: resizeS3Image-development
api keys:
  None
endpoints:
  GET - https://<api_key_here>.execute-api.eu-west-1.amazonaws.com/dev/{key+}
functions:
  handler: resize-dev-image
Serverless: Removing old service artifacts from S3...

When upload to AWS Lambda, the project will bundle only needed files - no dev dependencies will be included.

Usage (image restrictions resize)

To restrict the dimensions, we put a const var in the handle.js:

const ALLOWED_DIMENSIONS = {
  width: 1800,
  height: 1800
};

You can also change the url endpoint https://<api_key_here>.execute-api.eu-west-1.amazonaws.com/dev/{key+} to another one more tiny and cachable (cloudfront), you can also configure in you Api Gateway (lambda service) a Custom Domain Name.

Example URL usage

https://<api_key_here>.execute-api.eu-west-1.amazonaws.com/dev/<KEY_S3_IMAGE_HERE>?width=<WIDTH>&height=<HEIGHT>

or with you own Custom Domain Names:

https://api.yourdomain.com/<KEY_S3_IMAGE_HERE>?width=<WIDTH>&height=<HEIGHT>

Example usage of lambda resize image

Environment variables

  • URL - AWS URL S3 bucket or your CDN url to the BUCKET. (not required in version 2.0)
  • BUCKET - AWS S3 bucket. (required)

Environment variables for serverless

  • AWS_ACCESS_KEY_ID - AWS key
  • AWS_SECRET_ACCESS_KEY - AWS Secret

Local development

  1. $ npm i -g serverless
  2. $ npm i
  3. $ brew install imagemagick
  4. $ serverless offline start

Note that you will need to be into the root repository. The last command (4.) will spin up an serverless-offline version of an API Gateway, that will simulate the real one. Once it is running, you can see all the requests on your command line.

Example request

http://localhost:3000<YOUR_KEYNAME_TO_IMAGE>?width=<WIDTH>&height=<HEIGHT>

Configuration Parameters

| Parameter | type | description | | :-------: | :-----: | -------------------------------------------------- | | width | Integer | Required. Will resize image via imagemagic resize. | | height | Integer | Optional. Will resize image via imagemagic crop. |

Feedback

We'd love to get feedback on how you're using lambda-resize-image and things we could add to make this tool better. Feel free to contact us at [email protected]

Contributing

If you'd like to contribute to the project, feel free to submit a PR. See more: CODE_OF_CONDUCT.md

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Author

  • Miguel Vieira - Initial work - apoca

See also the list of contributors who participated in this project.