Skip to content
Package and deploy apps built with NodeGUI to all platforms
TypeScript JavaScript
Branch: master
Clone or download
Latest commit d2d248a Sep 2, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Fix mac build Sep 1, 2019
template Fixes linux builder Aug 31, 2019
.gitignore Adds basic macos packaging support Aug 28, 2019
README.md Update README.md Sep 2, 2019
package-lock.json Fix mac build Sep 1, 2019
package.json Fix mac build Sep 1, 2019
tsconfig.json Adds basic macos packaging support Aug 28, 2019

README.md

Packer 📦

Packer is a npm module that allows you to package apps built with NodeGUI or React NodeGUI into a standalone executable. Packer works on Mac, Windows and Linux

This is a initial MVP release of the module.

On MacOS - Packer will output a dmg file

On Linux - Packer will output an AppImage which is something similar to a .app file in MacOS

On Windows - Packer outputs a folder containing the executable and all the dlls.

Currently if you need to produce a build you need to run the packer in different OS environments. That is, cross platform builds are not supported in this release.

Usage

  • First step is to install the packer as a dev dependency. You can do so by:

    npm install --save-dev @nodegui/packer

  • Next you can run the init command:

    npx nodegui-packer --init MyApp

    This will produce the deploy directory containing the template. You can modify this to suite your needs. Like add icons, change the name, description and add other native features or dependencies. Make sure you commit this directory.

  • Next you can run the pack command:

    npx nodegui-packer --pack <path to dist>

    This command essential takes the dist folder as the input and puts it in the suitable location inside the standalone executable. Also it runs the correct deployment tool (macdeployqt incase of mac, etc) and packs in the dependencies. The output of the command is found under the build directory. You should gitignore the build directory.

How does it work ?

Packer uses Qt's packaging tools in all three platforms.

Requirements

  • Needs Qode v1.0.4 and up (NodeGUI v0.1.7 and up)

Future enhancements:

  1. Cross platform builds.
  2. Better documentation.
  3. Reduce / Remove unnecessary dynamic libraries.
  4. Reduce qode binary size.

Please feel free to help out with this in anyway you can.

You can’t perform that action at this time.