Skip to content

trash07/image-processing

Repository files navigation

Image processing API

The purpose of this project is to provide image processing

API testing url

http://localhost:3000/api/images

Required query strings to work:

  • filename => The name of the file (encenadaport, fjord, icelandwaterfall, palmtunnel, santamonica or any newly added filename without extension)
  • width an integer value specifying the desired width (Example: 300)
  • height an integer value specifying the desired height (Example: 200)

Example:

http://localhost:3000/api/images?filename=fjord&width=300&height=100

or

curl http://localhost:3000/api/images?filename=fjord&width=300&height=100

Commands

Installing dependencies

To start using the project don't forget to run the following command.

npm install

Running project (default server port is 3000)

In dev mode (with nodemon and livereload)

npm run start:dev

In production mode

npm run start

Testing, linting and prettier

To test the project, run the following command.

Things to check before running the command:

  • npm is installed and running a recent version
npm run test

The test command runs linting, prettier and converts typescript to javascript.

The converted code is in the dist folder.

To lint separately type:

npm run lint

To run prettier separately run:

npm run prettier

About

Image processing API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published