Skip to content

mahmoudalnkeeb/ImageProcessingAPI

Repository files navigation

ImageProcessingAPI

A RESTful Image Processing API built with Express, TypeScript, and Sharp, featuring testing with Jasmine.


Getting Started

Follow these steps to set up and run the Image Processing API.

Prerequisites

  • Node.js (version 20.18.0 LTS or later)
  • npm (comes with Node.js)

Installation

  1. Install Required Modules:

    npm install
  2. Build the Application:

    npm run build

Running the Application

  • Start the Development Server:

    npm run dev

Testing

  • Run Tests:

    npm run test

Linting and Formatting

  • Lint the Code:

    npm run lint
  • Format Code with Prettier:

    npm run prettier

Todos and Future Improvements

  • Development

    • unit testing with Jest.
    • Pipline for CI/CD with GitHub Actions.
  • Features

    • Add more image processing operations!
    • Add progress tracking for image processing operations.
    • bulk image processing operations.
    • Pipline image processing operations.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.


License

This project is licensed under the MIT License. See the LICENSE file for details.

About

Image Processing API using express , typeScript , Sharp , and testing with Jest

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published