Skip to content

Getting Started

Installation

Prerequisites

  • Node.js version 16 or higher.
  • Terminal for launching Stack Monitor (CLI).
  • Git to enable git capabilities.

To install in a git project:

sh
$ npm install -D @iryu54/stack-monitor
sh
$ pnpm add -D @iryu54/stack-monitor
sh
$ yarn add -D @iryu54/stack-monitor

To install in global:

sh
$ npm install -g @iryu54/stack-monitor
sh
$ yarn global add @iryu54/stack-monitor

Launch

In project installation, you can launch it by adding a script to your package.json:

json
{
  "name": "...",
  "version": "...",
  "description": "...",
  "main": "src/stack.js",
  "license": "...",
  "author": "...",
  "scripts": {
    "serve": "cross-env STACK_MONITOR_HTTP_PORT=6872 stack-monitor ./src/stack.js"
  }
}

Stack Monitor ships with a command line. After global installation, start it by running:

sh
$ stack-monitor <config-directory>

It will launch a web interface to write and monitor all your services

launched