Giter Site home page Giter Site logo

mockgen's Introduction

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.

mockgen's People

Contributors

astronomersiva avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

ddanninger

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.