Code Monkey home page Code Monkey logo

grunt-node-webkit-builder's Introduction

grunt-node-webkit-builder NPM version Dependency Status

NPM

Let's you build your node-webkit apps for osx, win, and linux with grunt. It will download the prebuilt binaries for a specify version, unpacks it, creates a release folder, create the app.nw file for a specified directory and copys the app.nw file where it belongs.

Issues with the output should be reported on the node-webkit-builder issue tracker. Build Status

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-node-webkit-builder --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-node-webkit-builder');

The "nodewebkit" task

Usage Examples

grunt.initConfig({
  nodewebkit: {
    options: {
        platforms: ['win','osx'],
        buildDir: './webkitbuilds', // Where the build version of my node-webkit app is saved
    },
    src: ['./example/public/**/*'] // Your node-webkit app
  },
})

Options

Exactly the same as node-webkit-builder. You have the advantage to configure the files via Grunt.

Manifest Options

platformOverrides

Just like node-webkit-builder you can specify platform-specific manifest values.

{
    "name": "nw-demo",
    "version": "0.1.0",
    "main": "index.html",
    "window": {
        "frame": false,
        "toolbar": false
    },
    "platformOverrides": {
        "win": {
            "window": {
                "frame": true
            }
        }
    }
}

For more information see node-webkit-builder's Manifest Options.

## Troubleshooting

OSX ulimit

Darwin (OS X kernel) has a low limit for file descriptors (256 per process) by default, so you might get an EMFILE error or an error mentioning "too many open files" if youtry to open more file descriptors than this.

To get around it, run ulimit -n 1024 (or add it to your ~/.bash_profile). For more information, see henvic/osx-ulimit.

Release History

  • 2014-12-12 1.0.0 64-bit support, improved platform-overrides and no more EMFILE errors. Also, macPlist CFBundleIdentifier is generated from package.json.
  • 2014-08-01 0.3.0 macPlist option improvements (see mllrsohn/node-webkit-builder#96)
  • 2014-08-01 0.2.0 Moved logic into a separate module, config options will be backward compatible except keep_nw is no longer supported
  • 2013-09-19 Removed config merging (but kept the lookup for version number and name), added keep_nw option, fixed various small bugs.
  • 2013-09-09 fixed accidential deletion of nw.exe on windows builds, adding several improvements, opt in for timestamped builds, using version and name from package.json to name the build product and build dir, renamed download directory to cache, added merge from package.json options for nodewebkit (no need to add configuration to Gruntfile, but stays optional)
  • 2013-08-20 fix for the unzip lib
  • 2013-08-13 initial release

grunt-node-webkit-builder's People

Contributors

steffenmllr avatar adam-lynch avatar gabepaez avatar wilkerlucio avatar autarc avatar nemurimasu avatar bastimeyer avatar vladikoff avatar shellka avatar shinnn avatar rawcreative avatar adametry avatar rbrcurtis avatar ruanyl avatar rogerwang avatar nolanlawson avatar bored-engineer avatar hugoruscitti avatar gion avatar

Watchers

James Cloos avatar  avatar  avatar Strateg avatar

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.