Skip to content

Build NW.js applications for Linux, MacOS and Windows

License

Notifications You must be signed in to change notification settings

TinsFox/nw-builder

 
 

Repository files navigation

nw-builder

npm Join the chat at https://gitter.im/nwjs/nw-builder

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

For version 3, please go to the corresponding branch.

Major Features

  • Get, run or build applications.
  • Integrate FFmpeg community builds
  • Configure executable fields and icons
  • Downloading from mirrors
  • Node Native Addon support

Check out the documentation if you wish to give nw-builder a try.

Please note that the documentation assumes you know how to write NW.js applications.

Installation

With npm:

npm install nw-builder -D

With yarn:

yarn add nw-builder -D

With pnpm:

pnpm add nw-builder -D

Usage

Here is two way to use nw-build to build your nwjs applications

CLI

  1. To get nwjs cache
    nwbuild --mode=get
  2. To run nwjs application
    nwbuild --mode=run
  3. To build nwjs application
    nwbuild --mode=build

JavaScript API

  1. Define an npm script
    {
      "scripts": {
        "build": "node scripts/build.js"
      }
    }
  2. Create a build script
    // scripts/build.js
    const { nwbuild } = require("nw-builder");
    await nwbuild({
      srcDir: "./nwapp/**/* ./other/**/*.js",
      mode: "build",
      version: "latest",
      flavor: "normal",
      platform: "linux",
      arch: "x64",
      outDir: "./build",
      cache: false,
      app: { ... },
    });
  3. Run the script
    npm run build

Alternatives

About

Build NW.js applications for Linux, MacOS and Windows

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 98.4%
  • Other 1.6%