Package a Node.js application as an OS X application

javascript node.js macos native packaging

17,296

Solution 1

Option 1: Electron (formerly atom-shell)

This is the shell that GitHub's Atom and Microsoft's Code editors use. It’s very similar to node-webkit, though it will run the script first, and you have to create a view/window for the user. There are some other minor differences, but it's worth looking at.

Option 2: NW.js formerly node-webkit

The gist is that it basically extends the JavaScript engine for you to write a web-based application supporting Node.js' extended object model, and modules... you then package your package.json start.html modules and JavaScript files into a ZIP file (with the .nw extension) and run it with nw(.exe) .. there are Windows, Mac and Linux builds available.

Option 3: Neutralinojs Github

Neutralinojs is a lightweight and portable desktop application development framework. It lets you develop lightweight cross-platform desktop applications using JavaScript, HTML and CSS. You can extend Neutralinojs with any programming language (via extensions IPC) and use Neutralinojs as a part of any source file (via child processes IPC).

Option 4: MacGapNode (OS X only)

MacGap with Node.js integration (it seems to be getting stale)

Option 5: Tauri Github

Tauri is a toolkit that helps developers make applications for the major desktop platforms - using virtually any frontend framework in existence. The core is built with Rust and the CLI leverages Node.js making Tauri a genuinely polyglot approach to creating and maintaining great apps.

Aside: Services...

I can't speak for OS X on this as a .App, but it could well be possible to create a background service install in Node.js and a link to a "local" site on the desktop. Most browsers have an option to not show all the features (I know Firefox in particular does).

I know your question is to OS X in particular, but in Windows you can use NSSM to run anything as a service, and I have used it for Node.js-based services in Windows. I think some of the other options above are better depending on your needs though.

Removed:

~~nexe~~ - stale/unmaintained
~~AppJS~~ - replaced with DeskShell
~~DeskShell~~ - stale, website offline
~~node-webkit~~ - renamed to NW.js
~~XULRunner~~ project stalled, and exceedingly behind.
~~Thrust (Node Adapter)~~ - deprecated/stale
~~Carlo Chrom(ium) shell from Node.js.~~ - unmaintained/stale

This answer is copied for multiple questions, and these references are mostly for updating convenience.

Solution 2

Here's a screencast + writeup on the subject of an installer (.pkg):

How to create an OS X pkg for NodeJS apps

As for the .app, I'm not sure yet, but I'm hot on the trail.

Also:

Solution 3

Check out AppJS - "Build Desktop Applications for Linux, Windows and Mac using HTML, CSS and JavaScript"

It sounds like a good match :)

Solution 4

Check out NW.js - it's a project sponsored by Intel to package up Node.js applications for the desktop.

Specifically, see Creating Desktop Applications With node-webkit.

Solution 5

If you compile Node.js from source, every JavaScript file from Node.js' lib folder will be included into the binary. That same way could pack your code into the binary.

I am not familiar how Mac OS X packages are created, but at the end it does not seem to be very hard. Just pack your custom Node.js binary into one.

View more solutions

17,296

Author by

luisgo

Updated on June 03, 2022

Comments

luisgo almost 2 years

I want to build an interface for a series of terminal commands that our developers use to manage their development environments. I'd like to try to build it in Node.js.

Now, I'm thinking I can create it as an HTML5/CSS 3/JavaScript application using Express.js, etc... and then would like to package it as a native OS X application. Meaning, an application that I can just send them, they double click on and run, but that either launches a Chrome browser and navigates to the localhost:port server that hits the script or simply starts the server and instructs the user to go to the URL. Either way is fine.

I am doing this because I need access to the local system to be able to configure a number of things and interact with any number of running (headless VMs). So I can't simply serve this from a server and have them visit the site.

Any ideas?
Martin Cleaver about 10 years

Per twitter.com/appjs/status/394911856910823424 - appjs was superseded by github.com/rogerwang/node-webkit
Tracker1 about 5 years

@JasonJ.Nathan thanks, updated to remove thrust, and add Carlo in.
Jason J. Nathan about 5 years

Carlo is interesting in that it assumes Chrome is installed. Very interesting indeed :)
st_phan over 3 years

Carlo is now officially unmaintained – might make sense to remove it from the list @Tracker1 (Source: github.com/GoogleChromeLabs/carlo/issues/…)
rx2347 over 3 years

Tauri should be coming up on this list shortly
Peter Mortensen almost 3 years

Per the reference: "AppJS project has not been actively developed for a few years. Please check out NW.js or Electron instead."
Peter Mortensen almost 3 years

Can you summarise here? Those links may break at any time.
Tracker1 over 2 years

@st_phan deprecated carlo
Tracker1 over 2 years

@rx2347 added tauri