n8n Custom Nodes – Surense

This project contains custom nodes for n8n.

Prerequisites

• git

• Node.js >= 20 and npm (nvm instructions)

• Install n8n globally:

  npm install n8n -g
  

• Recommended: follow n8n's development environment guide

Local Installation (Mac/Linux)

Add to your shell config (~/.zshrc or ~/.bashrc):

export N8N_CUSTOM_EXTENSIONS=/Users/rotemb/Desktop/n8n-nodes-surense/dist

Reload shell:

source ~/.zshrc

Start n8n:

n8n start

Docker Installation

Example docker-compose.yml:

version: '3.9'
services:
  n8n:
    image: n8nio/n8n
    ports:
      - '5678:5678'
    environment:
      - N8N_CUSTOM_EXTENSIONS=/home/node/.n8n/custom
    volumes:
      - /Users/rotemb/Desktop/n8n-nodes-surense/dist:/home/node/.n8n/custom

Run:

docker compose up -d

Development

Build nodes:

npm run build

Start n8n:

n8n start

Optional: Hot Reload

Install nodemon:

npm install -D nodemon

Add to package.json:

"scripts": {
  "dev:n8n": "nodemon --watch dist --ext js --exec 'n8n start'"
}

Run nodemon:

npm run dev:n8n

Edit TypeScript files in src/ while npm run dev watches and rebuilds them. n8n will restart whenever dist/ changes.

More Information

See n8n's node creation documentation for details on building your own nodes.