dekiakbar / image-optimizer

Imageoptimizer image is a simple app for compressing any image file. It takes a single input file and compresses it to a much smaller output file.

Image Optimizer Backend

---

Table of Contents

• Installation
  • Without docker
  • Docker
• Deployment
• Environment Variable
• Frontend
• License

Installation

Backend (this repo)

• Without docker

  •   # Clone this repository
      git clone https://github.com/dekiakbar/image-optimizer

  •   # Navigate to project dir
      cd image-optimizer

  •   # Install node modules and dependencies
      npm install

  •   # Run app
    
      # development
      $ npm run start
    
      #  Watch mode
      $ npm run start:dev
    
      # production mode
      $ npm run start:prod

  •   # access swager api
      http://localhost:<port>/api

• Docker

  •   # Clone this repository
      git clone https://github.com/dekiakbar/image-optimizer

  •   # Navigate to project dir
      cd image-optimizer

  •   # Build image and start container
      docker-compose up -d

  •   # access swagger api
      http://localhost:3000/api

  • NOTE : if you wanna run npm command, please use this.

    docker-compose run --rm node npm install --legacy-peer-deps

Deployment

• Docker

  •   # Clone this repository
      git clone https://github.com/dekiakbar/image-optimizer

  •   # Navigate to project dir
      cd image-optimizer

  •   # Build image and start container
      docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d

Environment Variable

Copy env.example to .env

cp .env.example .env

Fill the required env variables:

PORT=3000

# Storage type for save image
# valid :
# - S3
STORAGE_TYPE=S3

# if use S3 as storage
S3_BUCKET_NAME=
S3_REGION=global
S3_ENDPOINT=
S3_ACCESS_KEY_ID=
S3_SECRET_ACCESS_KEY=

# separated by space and please provide (dot) before list the extension
ALLOWED_FILE_TYPE=.jpeg .jpg .png
MAX_FILE_UPLOAD=5
# max upload size in KB
MAX_UPLOAD_SIZE=8192

Frontend

You must install image optimizer Frontend.

License

MIT

image-optimizer's Issues

CORS

Access to XMLHttpRequest at 'https://api.imageoptimizer.nooby.dev/api/v1/optimize' from origin 'https://imageoptimizer.nooby.dev' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

Build Workflow

• build app in github action

prepare for release

• update package.json

Github action testing

add github action for testing

Use .env.example for testing

Use .env.example for testing

Update Readme

• add badge
• table of content

S3 Integration

Need to integrate S3 object storage

End to End testing

Unit testing

image size is bigger than original image

sometimes image result are bigger than original images.

Update Swagger

• change swagger url to /api
• updade swagger response

Update unit test

Update unit test
Update github action workflow to run link and build only if test completed

update NestJs and dependencies

Deploy only when merged to master

current state :

• if PR is opened will trigger github action to deploy
• if PR is merged will also trigger github action to deploy which is make deployment

Add rate limit

Add nestjs throttle for request