https://github.com/nikhilw/node-selfx-packager

A package script for node and demo repository
https://github.com/nikhilw/node-selfx-packager

distribution nodejs packaging

Last synced: about 2 months ago
JSON representation

A package script for node and demo repository

• Host: GitHub
• URL: https://github.com/nikhilw/node-selfx-packager
• Owner: nikhilw
• License: mit
• Created: 2017-02-05T07:13:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-02-25T13:38:23.000Z (over 7 years ago)
• Last Synced: 2024-06-03T09:45:54.805Z (4 months ago)
• Topics: distribution, nodejs, packaging
• Language: Shell
• Size: 6.84 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-selfx-packager

A packaging script for node and demo repository

## Prepare

* Clone the repository

* cd into mymodule directory and run: ```npm install```

* Test your module by running the script: ./workDir/run_module_directly.sh

## Package

cd to the base of the repository and run the command below to package the application.

```bash

./selfXpackager.sh -s node-bin/launcher.sh -n selfExeSample -b node-bin/node -m mymodule/ -o dist/

```

## Run

cd to workDir directory to apply overrides, or any directory where you would rather keep your overrides file and run the command below.

```bash

../dist/selfExeSample_launcher.sh

```

OR, if you had passed arch flag as x64, then:

```bash

../dist/selfExeSample_x64_launcher.sh

```

Note: it has name as: <process name>[_<arch flag>]_launcher.sh

## Options

* s: Path of the launcher **script**

* n: **Name** of the final process when it starts.

* b: Path to node.js **binary**

* m: Path to nodejs **module** with dependencies

* o: **Output** directory for the package.

* t: Direct path to gzipped **tar** file, if you already have bundled it.

* a: Processor/OS arch, Ex. x86/x64. Only used in file name, so you know which file is built with which node binary. 

## Directory structure

* /mymodule: a sample node package. Check out the index.js file for sample code.

* /node-bin: a directory place your node binary in. Does not have to be done so, but the command becomes easier that way.

* /workDir: a directory to run the package from. There is a sample config overrides files in there.

* /dist: This is where the output will be generated by the script.

## Optionally loading js files

There was a requirement to allow a .js type file for configuration instead of .json. This can be achived by passing the full path to this .js as an attribute of application.json and requiring it from within application. Ex: ```{"config": "/.../application.config.js"}```.