Code Monkey home page Code Monkey logo

img-processing-api's Introduction

Image Processing API

A simple API for resizing images, saving them on disk and serving them on the browser.

How to run the project

  • Check if Node version 16.13.9 installed on your system, then check if the instalation has gone correctly by typing

    $ node --version
    $ 16.13.0
    
  • Install the dependencies by typing the command

    $ npm install
    
  • Make sure to add your images that you want to process in the assets/full folder.

  • Start the server by typing the command

    $ npm run start
    

Endpoint for resizing images

  • This endpoint will render your image as is without any modification

    GET /api/images?filename=FILENAME
    
  • This endpoint will render the resized image. You should replace FILENAME, WIDTH, HEIGHT with your specific values

    GET /api/images?filename=FILENAME&width=WIDTH&height=HEIGHT
    

How to run the tests

NOTE: The tests won't pass until you start the server.

  • Run your tests by typing the command.

    $ npm run test
    

img-processing-api's People

Contributors

3to1dash avatar dependabot[bot] avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.