dodysat/image-resizer repository overview

⁠

⁠Image Resizer

Resize your image on the fly from S3 Compatible Storage
Explore the docs »⁠

View Demo⁠ · Report Bug⁠ · Request Feature⁠

(back to top⁠)

⁠About The Project

At the beginning of making a project, you may directly upload images to S3 and don't think that you will have various types of devices or clients that require different image sizes. This application can be used to resize images directly when your client requires images of different sizes

(back to top⁠)

⁠Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

⁠Installation

1. Clone the repo

   git clone https://github.com/dodysat/image-resizer.git
   

   Copy
2. Move to the directory

   cd image-resizer
   

   Copy
3. Install NPM packages

   npm install
   

   Copy
4. Copy .env.example to .env

   cp .env.example .env
   

   Copy
5. Edit .env file with your own configuration
6. Run the application

   npm start
   

   Copy

(back to top⁠)

⁠Docker Deployment

Anda dapat menggunakan image docker untuk mencoba aplikasi ini. Image docker tersedia di Docker Hub⁠

⁠Run with Docker

docker run -d -p 3000:3000 --name image-resizer -e \
AWS_ACCESS_KEY_ID=<your_aws_access_key_id> -e \
AWS_SECRET_ACCESS_KEY=<your_aws_secret_access_key> -e \
AWS_REGION=<your_aws_region> -e \
AWS_ENDPOINT=<your_aws_endpoint> -e \
IMAGE_QUALITY=<your_image_quality> -e PORT=3000 dodysat/image-resizer

(back to top⁠)

⁠Usage

Supported Parameters

• w : width

• h : height

• q : quality (between 1 to 100, higher is better, default is 80)

  ps: If you declare `w` and `h` at the same time, the image will be cropped. If you only declare one of them, the image will be resized proportionally.
  

  Copy

Example:

• https://cdn.instorages.com/image-resizer/sample/nested-directory/ERy7TXz8Mzg.jpg?w=512&h=512⁠ : Resize and crop image to 512x512 px
• https://cdn.instorages.com/image-resizer/sample/nested-directory/6TaW2xmXKUs.jpg?w=312&q=1⁠ : Resize image to 312px width and quality is 1

(back to top⁠)

⁠Roadmap

• Initial release
• Supports secure image capture using dynamic token-based authentication

See the open issues⁠ for a full list of proposed features (and known issues).

(back to top⁠)

⁠Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top⁠)

⁠License

Distributed under the Apache License. See LICENSE for more information.

(back to top⁠)

⁠Contact

Dody Satria - LinkedIn⁠ - [email protected]⁠

Project Link: https://github.com/dodysat/image-resizer⁠

(back to top⁠)