Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jgoralcz/image-microservice
Configurable, modifiable, blazing fast, and minimal memory footprint image processor in Node.js. Docker ready in seconds. PRs are welcomed!
https://github.com/jgoralcz/image-microservice
Last synced: about 1 month ago
JSON representation
Configurable, modifiable, blazing fast, and minimal memory footprint image processor in Node.js. Docker ready in seconds. PRs are welcomed!
- Host: GitHub
- URL: https://github.com/jgoralcz/image-microservice
- Owner: jgoralcz
- License: mit
- Created: 2019-05-08T09:10:01.000Z (over 5 years ago)
- Default Branch: dev
- Last Pushed: 2023-09-04T04:02:05.000Z (over 1 year ago)
- Last Synced: 2024-08-02T05:13:45.569Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 26.6 MB
- Stars: 10
- Watchers: 0
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - image-microservice - Configurable, modifiable, blazing fast, and minimal memory footprint image processor in Node.js. Docker ready in seconds. PRs are welcomed! (JavaScript)
README
# Manipulating Images Microservice (MIMS) - v2
MIMS is a microservice API which processes images using Node.js.
This microservice uses about 500mb of ram when starting out and can be up to 900mb or more due to the number of requests you have.
A default of 3 processes is created (see `config.json`). Processes are indeed heavy. Only create more if you really need the concurency.
You may need fewer or more depending on your use case. If that's the case then you must specify that when running
docker by changing the number of processes in your `config.json` file.
If your node version is less than 11.5 you must use `node --experimental-worker app.js` and install the 1 million dependencies (**use the Dockerfile and Docker!**)
**You can test a live instance here (you will be rate limited): `beta-mims.bongo.best`**
___
### Installation and Running
To install docker on linux (ubuntu or debian): `curl -sSL https://get.docker.com/ | bash` \
Otherwise, look it up.
Then simply run a docker command targeting my image on docker hub:
`docker rm -f mims || true && docker run -p 8443:8443 -d --restart=always --memory="1024m" --name mims joshgor01/image-microservice:beta`.
If you want dev branch changes, or check the other images at: https://hub.docker.com/repository/docker/joshgor01/image-microservice
Then you can view the logs with `docker logs -f mims`.
___
### How To Use
To use this microservice you must make a POST request to the provided endpoints and make sure you have
the correct `args` provided. In other words, look into each file under `/src/endpoints` and look at the structure.
1) The `name` is the endpoint.
2) The `filepath` is the location of the file I use to read in the buffer (you don't need to worry about this unless making your own).
3) The `args` are the list of arguments that **MUST** be met in order to process your image. Otherwise you will get a `400 bad request`.
4) You will receive back a buffer of the image if success. Otherwise error messages will be returned.
### Examples
I use this with `request-promise`.
```$xslt
options = {
method: 'POST',
uri: 'http://localhost:8443/api/' + endpoint, //endpoint is the image (see below)
encoding: null,
headers: {
'Content-type': 'application/json'
},
body: body,
json: true
};
```
If you do not want a buffer and want a string (say the `ascii` endpoint), set your options to
```$xslt
const options = {
method: 'POST',
uri: 'http://localhost:8443/api/ascii',
body: body,
json: true
};
```
_____
**Here are some examples with the body.**
1) The `hot` endpoint requires the `image_url` \
localhost:8443/api/hot
```$xslt
POST /api/hot HTTP/1.1
Host: localhost:8443
Content-Type: application/json
{"image_url": "https://pbs.twimg.com/media/DtwaeFtUwAAPbxk.jpg"}
```
2) The `hatkidsays` endpoint requires text \
localhost:8443/api/hatkidsays
```$xslt
POST /api/hatkidsays HTTP/1.1
Host: localhost:8443
Content-Type: application/json
{"text": "Make sure you brush your teeth!"}
```
3) The `halloweenify` endpoint requires an image url and a threshold. \
localhost:8443/api/halloweenify
```$xslt
POST /api/halloweenify HTTP/1.1
Host: localhost:8443
Content-Type: application/json
{"image_url": "https://pbs.twimg.com/media/DtwaeFtUwAAPbxk.jpg", "threshold": "1"}
```
___
## Contributing
I would recommend using the local.Dockerfile like so: `docker rm -f mims || true && docker build -t mims . -f local.Dockerfile && docker run -p 8443:8443 -d --restart=always --memory="1024m" --name mims mims`
## Pull Requests
If you would like to add your own fun creation, feel free to make a pull request!
My only request is to follow the current structure that is provided and make sure the endpoint is appropriate.