tonetechnician / nw-builder

Build NW.js applications for Mac, Windows and Linux

nw-builder

Build NW.js applications for Mac, Windows and Linux.

Installation

Install via npm or your package manager of choice:

npm install nw-builder

Usage

At a glance module usage:

import { nwbuild } from "nw-builder";

nwbuild({
  srcDir: "./nwapp", // directory to store nw app files
  version: "0.69.1", // latest or stable or 0.x.y
  flavour: "sdk", //sdk (dev) or normal (prod)
  platform: "linux", //linux, osx, win
  arch: "x64", //ia32 or x64
  outDir: "./build",
  // flags with their default values
  cacheDir: "./cache", //directory to store nw binaries and shared libraries
  downloadUrl: "https://dl.nwjs.io",
  manifestUrl: "https://nwjs.io/versions",
  run: false, //run app to quickly demo it
  noCache: false, //delete and redownload nw version
  zip: false, // optionally zip files
});

At a glance CLI usage:

nwbuild ./nwapp --version=0.70.1 --flavour=sdk --platform=linux --arch=x64 --outDir=./build

Contributing

1. Pick and install a Node version manager
   • Linux/OSX - nvm
   • Win 7+/Linux/OSX - volta
2. Use your version manager to install Node 14.19 or above
3. Run npm install
4. npm run demo to test your changes at first glance
5. npm t to run unit tests
6. Don't forget to run npm run format && npm run lint before commiting your changes
7. Whenever possible, open an issue before submitting a pull request
8. Ensure there are tests that cover your changes

License

MIT