https://github.com/saharaar/imageprocessingapi

an Image Processing API built using Node.js and Express.
https://github.com/saharaar/imageprocessingapi

Last synced: about 2 months ago
JSON representation

an Image Processing API built using Node.js and Express.

• Host: GitHub
• URL: https://github.com/saharaar/imageprocessingapi
• Owner: SaharAAR
• Created: 2023-12-25T22:56:22.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-01-02T18:57:49.000Z (12 months ago)
• Last Synced: 2024-01-02T19:51:06.317Z (12 months ago)
• Language: TypeScript
• Size: 739 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.txt

Awesome Lists containing this project

README

        
# Image Processing API

This project is an Image Processing API built using Node.js and Express. Created by Sahar R. 

## Installation & Scripts --------------

To install the dependencies, run:

`bash

npm install

- To start the server:

`bash

npm start

- To run tests using Jasmine

`bash

npm test 

- To run ESLint to check TypeScript files for linting errors.

`bash

npm run lint 

- To run ESLint and attempts to fix linting errors automatically.

`bash

npm run lint:fix

- Checks TypeScript files for formatting issues using Prettier.

`bash

npm run format

- Formats TypeScript files using Prettier and fixes any issues.

`bash

npm run format:fix

## Endpoints --------------

Endpoint: `GET /images`

Params:

- `filename`: Name of the image file (without extension)

- `width`: Width of the resized image

- `height`: Height of the resized image

Example:

http://localhost:3000/images/?filename=artist&height=600&width=600

Example:

http://localhost:3000/images/?filename=artwork&height=500&width=500

## Dependencies Used --------------

`ts

"devDependencies": {

    "@types/express": "^4.17.21",

    "@types/node": "^20.10.5",

    "@typescript-eslint/eslint-plugin": "^6.15.0",

    "@typescript-eslint/parser": "^6.15.0",

    "eslint": "^8.56.0",

    "jasmine": "^5.1.0",

    "prettier": "^3.1.1"

  },

"dependencies": {

    "express": "^4.18.2",

    "sharp": "^0.33.1",

    "typescript": "^5.3.3"

  },