01 Setup

Setting up the API on your machine

Note: while this could run on Windows, it has not been tested. Please use WSL if you are on Windows.

Installing the dependencies

While the NodeJS project has zero dependencies (except for types), you need the ImageMagick package.

On Debian-based distros (such as Ubuntu), you can install it using:

apt install imagemagick

If you are on another distro, install it through your package manager. If you are unsure if you have the right package, run the command which convert. If there is an output (e.g. /usr/bin/convert), you're ready to continue!

Setting up the repository

Clone the repository by using:

git clone https://github.com/BananaCrumbs/ImageFilterAPI

then go into the directory in your terminal.

After that, install the dependencies to build the project and compile:

# install typescript
npm i #or use yarn if you prefer

Congrats!

If you got no errors, you're ready to move on to the configuration page!

If you do have errors, feel free to create an issue or ask on discussions