ZeyadTarekk/Image-Processing-API

An API that allows you to place images into your frontend with the size set via URL parameters and resize the image based on the entered size

📝 Table of Contents

• About
• API Endpoint
• Get started
  • Installation
  • Running
  • Building for production
  • Running Tests
• Technology
• Contributors
• License

📙 About

• An API that allows you to place images into your frontend with the size set via URL parameters and resize the image based on the entered size.
• Same the resized image on /assets/thumb folder
• If the entered image and size are entered before, Cached version is used rather than generating a new version.

🔚 API Endpoint

GET /api/images?filename=<imagename>&width=<width>&height=<height>

🏁 Getting Started

This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructuins.

Installation

1. Clone the repository

$ git clone https://github.com/ZeyadTarekk/Image-Processing-API.git

2. Navigate to repository directory

$ cd Image-Processing-API

3. Install dependencies

npm install

Running

1. Running on development mode

npm run start

Open http://localhost:3000 with your browser to see the result

Building for production

1. Compiling for production mode

npm run build

Running Tests

npm run test

💻 Built Using

• Node.js
• Express.js
• TypeScript

Contributors

Zeyad Tarek

License

This software is licensed under MIT License, See License for more information ©ZeyadTarekk.