Skip to main content

Node.js: Bundling your Node.js application to single executable for Windows.

In this article, we will see how to bundle Node.js application to a single executable for Windows.

What's the need?

Well recently, I had taken a work where I needed to convert pdf's(Of similar format) to excel sheet.
So I was reading the pdf's from a folder in desktop and I was storing the output excel sheet into a separate folder on the desktop.
I used Node.js for the program.
Now the client wanted it to install the program on 25 windows machine and his budget was really low. So it was also not possible for me to install node.js for 25 machines and then install the required dependency for each one.

One of the solution:

While I was searching for an easy solution I found this amazing npm module pkg.
This module can make your node.js app work like plug and play type.
No need to install Node.js on the client machine or any other dependency. 
It helps to make a commercial or trial version of your node.js application without exposing the source code.
I found this very much easy as the budget was a hell low and no need to think for security issues for my use-case.

So let's check the code and package.json,

Install the pkg module in your node.js project.

npm i pkg 

You also need to add a bin property in your package.json and pkg property for adding
any external dependency only if you have.
In my case, I had a dependency on pdf-parse module to parse pdf and json2xls for creating an excel sheet.


  "name": "textfromimage",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  "pkg": {
    "assets": [
  "author": "",
  "license": "ISC",
  "dependencies": {
    "json2xls": "^0.1.2",
    "pdf-parse": "^1.1.1"

Here index.js is my entry file which runs the program.
Also, check assets where I had defined external dependencies for the project.

Now, run pkg . --target node10-win-x64 from your app directory to build an executable for Windows.
By not providing a target it will build for all three platforms Windows, Linux, and OSX.
That's it!
Your executable for Windows will be created in your app directory.
This solves my problem, Now I can easily share the exe file and can run it like any other windows application.

I hope you like this article and if any doubts or if you have anything better please let me know in the comment section.

Subscribe this blog for more such articles.
You can also follow me on Twitter or Linkedin for the latest updates.

If you like our article and if you can support us please do click here


Popular posts from this blog

Node JS:Understanding bin in package.json.

Well as a Node Js developer we know package.json as dependency file where we keep a note of all dependencies of our project. Here we will be looking at what is bin in package.json? To understand this we first need to understand command line application and it's purpose. CLI applications are mostly used to automate things such as deployments of application,running tests,building reports and the list goes on and on. So lets start with creating our first CLI application. First, let’s make sure you have the tools required. To complete this tutorial, you will need the following: 1)A recent version of Node.js downloaded and installed 2)A good text editor, such as Visual Studio Code Next, open your computer’s command prompt (Windows) or terminal (macOS/Linux). Change the current directory to the folder where you save your documents or projects. Enter the following commands to create a new project folder and initialize the project. mkdir hello-cli cd hello-cli npm init Nex

Node.js: Extract text from image using Tesseract.

In this article, we will see how to extract text from images using Tesseract . So let's start with this use-case, Suppose you have 300 screenshot images in your mobile which has an email attribute that you need for some reason like growing your network or for email marketing. To get an email from all these images manually into CSV or excel will take a lot of time. So now we will check how to automate this thing. First, you need to install Tesseract OCR( An optical character recognition engine ) pre-built binary package for a particular OS. I have tested it for Windows 10. For Windows 10, you can install  it from here. For other OS you make check  this link. So once you install Tesseract from windows setup, you also need to set path variable probably, 'C:\Program Files\Tesseract-OCR' to access it from any location. Then you need to install textract library from npm. To read the path of these 300 images we can select all images and can rename it to som

Node.js: create an excel file with multiple tabs.

This article is a sample code to generate an excel file with multiple tabs using  excel4node  module. Install: npm i excel4node Let's see the sample code, var excel = require( 'excel4node' ); // Create a new instance of a Workbook class var workbook = new excel.Workbook(); // Add Worksheets to the workbook var worksheet = workbook.addWorksheet( 'Buy order types' ); var worksheet1 = workbook.addWorksheet( 'Sell order types' ); // Style for headers var style = workbook.createStyle({ font : { color : '#EA3A14' , size : 18 }, numberFormat : '$#,##0.00; ($#,##0.00); -' }); var styleForData = workbook.createStyle({ font : { color : '#47180E' , size : 12 }, alignment : { wrapText : true , horizontal : 'center' , }, numberFormat : '$#,##0.00; ($#,##0.00); -' }); let buyOrderTypes = [ {name : "buy" ,id : "1" ,comment : "Normal