Package Exports

mj-mockup-generator

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mj-mockup-generator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

mj-mockup-generator

Simple & easy to use mockup generator from MockupsJar

Install

$ npm install mj-mockup-generator

How to use the library

User our Free API

Use our Free API Tier with 10 tasks /hour

Register an user on https://mockupsjar.com/
Go to your profile page and generate a token https://mockupsjar.com/profile
Use the token with your preferred API tool or library (this npm package or Postman or Axios)

Usage

const mockupGenerator = require('mj-mockup-generator');
const generator = new mockupGenerator(); // OR {key: process.env.API_TOKEN}

const data = {
    zoomLevel: 0.5,
    format: "jpg",
    input: ['https://dummyimage.com/750x1334/7dffb8/000000']
};

let response = await generator.render('iphone7-red', data);
console.log('response', response);

List all mockups

const mockupGenerator = require('mj-mockup-generator');
const generator = new mockupGenerator();

let response = await generator.list();
console.log(response);

Get info about a mockup

const mockupGenerator = require('mj-mockup-generator');
const generator = new mockupGenerator();

let response = await generator.getInfo('iphone7-red');
console.log(response);

Render simple mockup

const mockupGenerator = require('mj-mockup-generator');
const generator = new mockupGenerator();

const data = {
    zoomLevel: 0.5,
    format: "jpg",
    input: []
};

let task = await generator.render("iphone7-red", data);
console.log(task);

Render mockup with image

const mockupGenerator = require('mj-mockup-generator');
const generator = new mockupGenerator();

const data = {
    zoomLevel: 0.5,
    format: "jpg",
    input: ['https://dummyimage.com/750x1334/7dffb8/000000']
};

let task = await generator.render("iphone7-red", data);
console.log(task);

Render mockup with website

const mockupGenerator = require('mj-mockup-generator');
const generator = new mockupGenerator();

const data = {
    zoomLevel: 0.5,
    format: "jpg",
    input: ['https://m.imdb.com/title/tt2395427/']
};

let task = await generator.render("iphone7-red", data);
console.log(task);

Resources

MockupsJar

MockupsJar API Doc

MockupsJar NPM Package