Image Processing Server

This project is an Image Processing Server that allows users to upload images, process them, and view thumbnail images.

Table of Contents

1. Introduction
2. Getting Started
   • Prerequisites
   • Installation
3. Scripts
   • Test
   • Start
   • Build
4. API Endpoints
   • Upload Image
   • Process Image
   • Get Thumbnail Images
5. Front End

Introduction

The Image Processing Server allows users to upload images, process them with custom settings, and view the processed thumbnail images.

Getting Started

Prerequisites

• Node.js and npm installed

Installation

Clone the repository and install dependencies:

git clone https://github.com/shereenbashar2/image-processing-api.git
cd image-processing-server
npm install

Scripts

Test

Run tests using:

npm test

Start

Start the server: npm start

The server will be running at http://localhost:3000.

Build

Build the project:

npm run build

Test

Test The project

npm run test

API Endpoints

Upload Image

Description: Upload an image for processing. Method: POST Path: /api/images/upload

Process Image

Description: Process an uploaded image with custom settings. Method: GET Path: /api/images/process-image Query Parameters: imageName (string): Name of the image format (string): Format of the processed image (e.g., jpg, png) quality (number): Quality of the processed image (0 to 100) width (number): Width of the processed image height (number): Height of the processed image

Get Thumbnail Images

Description: Retrieve a list of thumbnail images. Method: GET Path: /api/images/thumbnails

Front End

URL: localhost:3000

The Front End of the Image Processing Server provides a user-friendly interface for managing images, including uploading, processing, and viewing thumbnails.

Uploading More Images

Users can upload additional images directly through the Front End. When new images are uploaded, they are stored in the assets/original directory.

Displaying Thumbnails

Thumbnail images are automatically generated for the uploaded images and are stored in a dedicated thumbnails directory. These thumbnails provide a quick preview of the processed images.

Image Processing Options

Users can select how to process a specific image by utilizing the Image Processing Options feature. This includes choosing the output setting the quality level (0 to 100), and specifying the desired width and height for the processed image.