nv-node-builder v1.0.0

Node.js application builder

A complete solution to package and build Node.js application ready for Docker container, Linux service and Windows service.

Requirements

• Node.js >= 10.12.0

Installation

Install package globally:

$ npm install nv-node-builder -g

Configuration

Add a builder property to your package.json.

See the example below:

"builder": {
  "dirs": {
    "build": "./build",
    "src": "./dist"
  },
  "node": "10.12.0",
  "entry": "app.js",
  "environments": [
    "docker",
    "windows-x64",
    "linux-x64"
  ],
  "copy": [
    {
      "from": "./dist/config.json",
      "to": "./config.json"
    }
  ],
  "docker": {
    "externals": [
      "mongodb",
      "redis"
    ],
    "image": "12.10.0-stretch",
    "restart": "no",
    "volumes": [
      {
        "hostPath": "./log",
        "servicePath": "/usr/src/app/log"
      }
    ],
    "ports": [
      {
        "hostPort": 80,
        "containerPort": 8000
      }
    ]
  }
}

• dirs
  • build: path to the directory, where the build will be.
  • src: path to the directory, where your application files are.
• node: Node.js version, which will be used for binaries (please refer to https://github.com/nexe/nexe/releases).
• entry: entry file for your application.
• copy: an array of files that can be copied to an build. Optional.
  • from: path to the source of file.
  • to: path to the target of file.
• environments: array of environments for which the build will take place (supported: linux-x64, windows-x64, docker).
• docker:
  • image: container, on which will be your application container based on. Optional. Default: node:10-alpine
  • externals: list of containers which will be linked. Optional.
  • workdir: the directory in the application container where the application will run. Optional. Default: /usr/src/app
  • run: the array of commands that are executed when the container is initialized, Optional. Default: ["node","YOUR_APP_SHORTCUT.js"]
  • cmd: specifies the command to run in the container. Optional.
  • restart: container restart policy. Optional. Default: always. Values: always, no, on-failure or unless-stopped.
  • volumes: Optional
    • hostPath: specifies path on the host file system.
    • servicePath: specifies path in the container file system.
  • ports: Optional
    • hostPort: specifies port on the host file system.
    • containerPort: specifies port in the container file system.

Running

Go to directory with your application, run nv-node-builder and enjoy!