This project gives you a real-world scenario where you read and write to disk via a Node.js Express server rather than a database. It demonstrates how to set up scalable code and architecture while tying together some of the most popular middleware and utilities found in Node.js projects.

• Node.js (≥ 18)
• npm or yarn

Clone the repository and install dependencies:

git clone https://github.com/Laithamr05/Image-Processing-API.git
cd Image-Processing-API
npm install

Create a .env file (optional) to specify a custom port:

PORT=3001

Then start the server:

npm run dev

By default the server runs at:

http://localhost:3001

Verify that the server is running.

• URL: /health
• Method: GET
• Response:

  { "ok": true }

Sample:

GET http://localhost:3001/health

Resize images dynamically.

• URL: /api/images
• Method: GET
• Query Parameters:

• Response: Resized image (jpg) or JSON error.

Sample:

GET http://localhost:3001/api/images?filename=fjord&width=200&height=200

This resizes fjord.jpg to 200×200 pixels.

If width and height are omitted, the original image is returned.

Access pre-generated thumbnails stored in assets/thumb.

• URL: /thumb/<filename>
• Method: GET
• Response: Static image file.

Sample:

GET http://localhost:3001/thumb/fjord.jpg

src/
  index.ts          # Server entry point
  routes/           # Express routers
  utils/            # Image processing functions (Sharp)
assets/
  full/             # Original images
  thumb/            # Cached / resized images
tests/              # Jasmine specs

• Only .jpg files are supported by default.
• Caching is implemented so repeated requests for the same dimensions return the cached file from assets/thumb.
• Error messages are returned in JSON when requests are invalid.