Giter VIP home page Giter VIP logo

project-image-processing-api's Introduction

How to Install?

clone this project then in the root folder run this command in terminal

npm install

How to run it?

to start the project run this command in terminal

npm run build && npm run start

Note Server Start at http://localhost:3000

How to run tests?

run this command in terminal

npm run test

Another script

  1. to run eslint
npm run lint
  1. to run eslint with fix mode
npm run lint:fix
  1. to run prettier
npm run format
  1. to start the app with nodemon for hot reload on changes
npm run start:hot-reload
  1. to build the app and transpile typescript files to javascript
npm run build

How To Use Examples

there is one api endpoint in this application /api/imageswhich takes 3 queryString parameters all of them required

  • name of type string for the image name, allowed names [encenadaport , fjord , icelandwaterfall , palmtunnel , santamonica]
  • width of type number with minimum value (1) and maximum value (5000) for the desired image width
  • height of type number with minimum value (1) and maximum value (5000) for the desired image height

Valid Example

http://localhost:3000/api/images?name=encenadaport&height=500&width=500

allowed names [encenadaport , fjord , icelandwaterfall , palmtunnel , santamonica]

Unvalid Examples

  • http://localhost:3000/api/images?name=encenadaport.jpg&height=500&width=500

  • http://localhost:3000/api/images?name=encenadaport

  • http://localhost:3000/api/images?name=encenadaport&height=500

  • http://localhost:3000/api/images?name=encenadaport&&width=500

project-image-processing-api's People

Contributors

abdullahahmedmohamed avatar

Watchers

 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.