Image Processing Service

Description

Quick summary:

An image processing service for the CMS in our casino platform. The service will process images uploaded by operators before they are sent to the CDN. Key functionality includes image conversion to WebP format, generating type-specific image variations, and providing a cropping endpoint.

How to Setup?

To run this application, you'll need

• Git
• Node.js (which comes with npm) installed on your computer.
• Yarn

• Clone the repository using this command(in your Command Line)

git clone https://github.com/Comurule/image_processing_api.git

• Go into the repository

cd image_processing_api

• Create .env file for environmental variables in your root directory like the .env.example file and provide the necessary details.

• Install dependencies

yarn install

• Run the server

yarn start:dev # For dev mode

yarn build && yarn start:prod # For prod mode

• Check the port on the specified port on the env or 3000

API End Points

The Endpoints documentation can be gotten in this Postman documentation. More image types can be added in the Image Type Config File, with the necessary configurations.

Recommended Improvements

• API unit and integration testing

Author

Chibuike Umechukwu