Skip to content

daneedev/random-img-api

Repository files navigation

❔ About GitHub Workflow Status

With this package you can create API that will randomly generates images.

🏁 Installation

npm i randomimgapi

# Dev Version
npm i randomimgapi@dev

📜 Example

const { API } = require('randomimgapi')

API({
    imgFolder: 'img', // folder where you will store images
    port: 4000, // the port on which the api will run
    apiURL: '' , // leave it blank if you want use it on main page (https://yourdomain.com/)
    apiDomain: 'localhost:4000', // your domain on which will api work (if you want to use localhost do it with port)
    rateLimit: 10 // number of allowed requests per minute
})

✅ Hosting

  • Looking for free hosting for your API? Use DisHost!

➕ Links

Supported Versions

  • ✅ = These versions are recommended for use.
  • ❌ = These versions are not recommended for use.
Version Supported
1.0.x
1.1.x