Executable Template JS

Version: 1.0.0 Date: June 4, 2025

---

Description

A node application serving as template to build executable files for linux ,macos and windows.

Authors

@jadogeri

Repository

https://github.com/jadogeri/Executable-Template-JS.git

Screenshots

Table of Contents

• 1. Introduction
  • 1.1 Purpose
  • 1.2 Scope
  • 1.3 Intended Audience

• 2. Technology Stack

3. Usage

• 3.1 Testing the Executable

• 4. License

• 5. References

1. Introduction

1.1 Purpose

This document outlines a template to build executables in windows, macos and linux.

1.2 Scope

This template will allow users to:

• Create executables in windows, macos and linux.

1.3 Intended Audience

• Junior or Senior developers.
• Beginners learning javascript.

---

2. Technology Stack

• Programming Languages: Javascript
• IDE: Visual Studio Code (VSCode)
• Plugins: Early AI
• Source Control: Git and GitHub
• Code Analysis: SonarQube

3. Usage

0 Open a terminal then type git clone https://github.com/jadogeri/Executable-Template-JS.git to download to project.

git clone https://github.com/jadogeri/Executable-Template-JS.git

1 Type cd app to navigate into the app directory.

  cd app

2 Type npm install command to install dependencies.

  npm install 

3 Type npm run build to generate executable files for macos, linux and windows. Three files will be located in the dist directory.

  npm run build



3.1 Testing The Executable (windows)

4 Copy (executable-template-js-win.exe) in dist directory to app directory.

5 Double click on executable-template-js-win.exe. An output json file will be created.



4. License

LICENSE

---

5. References

• FreeCodeCamp : Frontend Web Development: (HTML, CSS, JavaScript, TypeScript, React).
• AweSome Open Source : Awesome Readme Templates
• Readme.so : The easiest way to create a README
• Medium : How to fix__dirname