Run your node locally#

You can test your node as you build it by running it in a local SMS-iT Workflow instance.

  1. Install SMS-iT Workflow using npm: 
    1
    npm install SMS-iT Workflow -g
  2. When you are ready to test your node, publish it locally: 
    1
2
3
    # In your node directory
npm run build
npm link

  3. Install the node into your local SMS-iT Workflow instance: 

    1
2
3
    # In the nodes directory within your SMS-iT Workflow installation
# node-package-name is the name from the package.json
npm link <node-package-name>

    Check your directory

    Make sure you run npm link <node-name> in the nodes directory within your SMS-iT Workflow installation. This can be:

    • ~/.SMS-iT Workflow/custom/
    • ~/.SMS-iT Workflow/<your-custom-name>: if your SMS-iT Workflow installation set a different name using SMS-iT Workflow_CUSTOM_EXTENSIONS.

  4. Start SMS-iT Workflow: 

    1
    SMS-iT Workflow start

  5. Open SMS-iT Workflow in your browser. You should see your nodes when you search for them in the nodes panel.

    Node names

    Make sure you search using the node name, not the package name. For example, if your npm package name is SMS-iT Workflow-nodes-weather-nodes, and the package contains nodes named rain, sun, snow, you should search for rain, not weather-nodes.

Troubleshooting#

  • There's no custom directory in ~/.SMS-iT Workflow local installation.

You have to create custom directory manually and run npm init 

1
2
3
4
# In ~/.SMS-iT Workflow directory run
mkdir custom 
cd custom 
npm init