Skip to content

Generates device mockups for a given URL using Puppeteer and Facebook Devices.

Notifications You must be signed in to change notification settings

astronomersiva/mockgen

Repository files navigation

mockgen Travis Build Status XO code style

Generates device mockups for a given URL using Puppeteer and Facebook Devices.

Install

  • Run npm install -g @astronomersiva/mockgen.
  • Download and extract Facebook Devices.
  • You will also need cairo installed
  • For macOS, run brew install pkg-config cairo libpng jpeg giflib.
  • For Ubuntu, run sudo apt-get install libcairo2-dev libjpeg-dev libpango1.0-dev libgif-dev build-essential g++.
  • For Windows, follow these instructions.

Usage

Run mockgen -u URL to generate a mockup for the given URL.

Flags

  • -a, --assets - Path to folder that contains Facebook Devices. Defaults to the current directory. Example, ~/Downloads.
  • -d, --device - Optional. The device for which you want a mockup. If not passed, a menu will be displayed with the list of available devices.
  • -s, --shadows - Optional, defaults to true. If the base images used for the mockups should have shadows.
  • -u, --url - The URL of the website that you wish to mockup.
  • -h, --help - Get the list of flags.
  • -v, --version - Get the current version of mockgen.

Screenshot

mockgen gif

FAQ

Will more devices be supported?

Yes, I will be adding more devices gradually. The reason for this is that the base images have x and y offsets which need to be calculated. You are welcome to contribute :)

Will landscape mode be supported?

Yes, once support for rotating images is available in merge-images. I have started working on it.

Why is Facebook Devices not bundled with mockgen?

Facebook's TOC are a little vague but from what I understand, it prohibits people from repackaging and redistributing.

About

Generates device mockups for a given URL using Puppeteer and Facebook Devices.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published