ImageResizingAPI

LinkedIn


Logo

ImageResizingAPI

an api that's used to resize images with jpg format
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. Contact
  6. Acknowledgments

About The Project

Product Name Screen Shot

This is a simple fullstack project whose purpose is to apply resizing on any image to a specified size without affecting the quality of the picture

(back to top)

Built With

(back to top)

Getting Started

To get started you need node.js installed on your own system:

install node

Installation

  1. Clone the repo
    git clone https://github.com/xValenciax/ImageResizingAPI
    
  2. Install required NPM packages
    npm install express multer sharp 
    
  3. Run the following command to run the project in dev mode
     npm run dev
    

    or

     npm run start
    

    to run project in production mode

(back to top)

Usage

Product Name Screen Shot

this is a descriptive screeshot that shows how to interact with the home page

hint: images should always exist in this path ./public/assets/full in order to be successfully accessed. you could either add them manually or upload them via the API

example URIs:

  1. go to home page
     https://xvalenciax.github.io/ImageResizingAPI/public
    
  2. test the resizing process

     https://xvalenciax.github.io/ImageResizingAPI/api?image=encenadaport.jpg&width=400&height=400
    

For more examples, please refer to the Documentation

(back to top)

Contact

Your Name - @LinkedIn profile - email@email_client.com

Project Link: Github Repo

(back to top)

Acknowledgments

(back to top)