Skip to content

Latest commit

 

History

History
233 lines (156 loc) · 7.12 KB

README.md

File metadata and controls

233 lines (156 loc) · 7.12 KB
Raw

ember-cli-nwjs

npm version Dependency Status Build Status

An ember-cli addon for developing Ember.js applications with NW.js (formerly node-webkit).

  • Get started quickly with an application blueprint configured for NW.js.
  • Build, watch, and run the app in NW.js with a convenient command: ember nw.
  • Build and package your app for production in one step with the ember nw:package command.

Wicked Good Ember 2015: Build Better Desktop Apps With Ember

Sample apps built with this addon:

Table of Contents:

Installation

From the root of your Ember CLI project:

ember install ember-cli-nwjs

This will do the following:

  • Install the addon NPM package (npm install --save-dev ember-cli-nwjs)
  • Run the addon blueprint (ember generate ember-cli-nwjs)
    • Add the blueprint files to your project
    • Install the nw NPM package locally

Build, Watch, and Run NW.js

Command

You can execute ember build --watch then start up NW.js with a single command:

ember nw

As the app gets rebuilt during development, the NW.js window will automatically reload the current page, so you can see the changes that you made without having to stop and restart the entire process.

Options

The following command line options let you specify a target environment or change the directory where the built assets are stored.

--environment (String) (Default: 'development')

  • Target environment for the Ember app build
  • Alias: -e <value>, -dev (--environment=development), -prod (--environment=production)

--output-path (String) (Default: 'dist/')

  • Output directory for the Ember app build
  • Aliases: -o <value>

NW.js Binary

This addon is configured to install NW.js from NPM and add it to your project as a local dependency.

To use a different NW.js:

  • Remove the nw dependency from your project (npm uninstall --save-dev nw)
  • Set an environment variable named NW_PATH that points to the desired binary. For instance, you may have downloaded the executable from the NW.js website and wish to use that instead.
  • On Windows, if the location of your nw.exe has been added to your PATH, then the NW_PATH environment variable does not need to be set.

Testing

Command

ember nw:test

Use this command to run tests in NW.js. ember nw:test will put Testem in CI mode, so the tests will execute once, then exit.

ember nw:test --server

Adding the --server flag will put Testem in Dev mode, so NW.js will stay running, and test results can be viewed both in the NW.js window and in Testem's terminal-based UI.

Options

You can pass the following command line options:

--environment (String) (Default: 'test')

  • Target environment for the Ember app build
  • Alias: -e <value>, -dev (--environment=development), -prod (--environment=production)

--server (String) (Default: false)

  • Run tests in interactive mode

--protocol (String) (Default: 'http')

  • The protocol to use when running with --server

--host (String) (Default: 'localhost')

  • The host to use when running with --server
  • Alias: -H

--port (Number) (Default: 7357)

  • The port to use when running with --server
  • Alias: -p

--module (String)

  • The name of a test module to run (available with --server)
  • Alias: -m

--filter (String)

  • A string to filter tests to run (available with --server)
  • Alias: -f

Packaging

Command

ember nw:package

This command builds your Ember app, assembles all the assets necessary for NW.js, then generates the final executable using nw-builder.

Options

You can pass the following command line options:

--environment (String) (Default: 'production')

  • Target environment for the Ember app build
  • Alias: -e <value>, -dev (--environment=development), -prod (--environment=production)

--output-path (String) (Default: 'dist/')

  • Output directory for the Ember app build
  • Aliases: -o <value>

--config-file (String) (Default: 'config/nw-package.js')

  • Configuration file for nw-builder
  • Aliases: -f <value>

Configuring nw-builder

nw-builder itself comes with a lot of build options. You can customize any of those settings by supplying a configuration file named config/nw-package.js in your project, or call ember nw:package with the --config-file option set to the desired file.

Configuration File

The configuration file must be a node module that exports a plain object with the names of the options you wish to override as keys:

// config/nw-package.js

module.exports = {
  appName: 'my-nw-app',
  platforms: ['osx64', 'win64'],
  buildType: function() {
    return this.appVersion;
  }
};

Default Settings

ember-cli-nwjs sets the following options by default:

  • files
    • Value: ['package.json', 'dist/**', 'node_modules/<name>/**']
    • 'node_modules/<name>/**' is listed for every non-dev npm dependency declared in your project.
  • platforms
    • Value: [<current_platform>]
  • buildDir
    • Value: build/app
  • cacheDir
    • Value: build/cache

Contributing

Working with master

To install the addon from master, run the following:

git clone git@github.com:brzpegasus/ember-cli-nwjs.git
cd ember-cli-nwjs
npm link

Then, in your Ember CLI project:

  • Add ember-cli-nwjs to your package.json's dev dependencies so that Ember CLI can discover and register the addon:
{
  "devDependencies": {
    "ember-cli-nwjs": "*"
  }
}
  • Link to your local ember-cli-nwjs and go through the addon install steps:
npm link ember-cli-nwjs
ember g ember-cli-nwjs

Development

To pass the addon code through the linters during development, run ember build --watch.

Running Tests

To run the addon's test suite:

cd ember-cli-nwjs
npm install
npm test

Want to Help?

This addon was created to help Ember.js developers build applications in NW.js. If you find patterns that work well for you, or would like to suggest ideas to make this addon even better, feel free to open new issues or submit pull requests. I'd love to hear your feedback!

License

Licensed under the MIT license