Nodeschool Public Materials

    generator-studio-app

    1.0.0 • Public • Published

    Studio App Generator: quickly scaffold Studio apps

    Version Travis Build Status codecov Dependency Status LICENSE Downloads

    Yeoman generator for InVision Studio Apps

    🗒 Description

    This is a generator for making Studio apps using Node.js. This framework was built using Yeoman.

    🚀 Getting Started Tutorial

    A step-by-step guide to introduce you to the Studio App Generator is in the works. If you have not developed apps for Studio before, this tutorial will be a great place to get started.

    📌 Requirements

    Only Node.js 10+ and yeoman-generator 3+ is supported. Node.js 10 will reach end-of-life April 2021. After that point, we will continue to support the current LTS version of Node.js.

    ✨ Features

    Composability

    Composability is a way to combine smaller parts to make one large thing. Sort of like Voltron®Yeoman docs

    Install

    $ npm install --save generator-studio-app

    Compose

    this.composeWith(require.resolve('generator-studio-app')/*, options */)

    Options

    {
        // supply alternative defaults
        appId: 'my-app',
        description: 'My description',
        name: 'My user',
        email: 'my@email.tld',
    }

    🏗 Usage

    First, install Yeoman and generator-studio-app using npm (we assume you have pre-installed node.js).

    $ npm install -g yo

    $ npm install -g generator-studio-app

    Then generate your new app:

    $ cd /path/to/where/you/want/to/write/your/apps

    Run $ yo, and select the Studio App option in the 'Run a generator' list.

    📣 Feedback

    Please share any suggestions or feedback with us through this form.

    License

    MIT © InVisionApp, Inc.

    Install

    npm i generator-studio-app

    DownloadsWeekly Downloads

    4

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    168 kB

    Total Files

    27

    Last publish

    Collaborators

    • keywordnew