Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alaa-yahia committed Oct 24, 2022
1 parent 9ab6878 commit 3333ea9
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# Image Processing API

A Simple API built using express framework that allows to display images on a web page with the size of the image is set via URL parameters.

## Things this api do

- Resizing images
- Serving cached images

To start server: `npm run start:server`
## To run the server

`npm run start:server`

## To build the server

`npm run build`

## To run tests

To build: `npm run build`
`npm run test`

To test: `npm run test`
## Endpoint to test the api

Endpoint: `http://localhost:4000/api/images?filename=fjord&width=200&height=400`

0 comments on commit 3333ea9

Please sign in to comment.