n8n-nodes-starter/README.md

n8n-nodes-starter

Example starter module for custom n8n nodes.

Try it out

N8N documentation on custom nodes

Clone the n8n-nodes-starter repository and execute:

# Install dependencies
npm install

# Build the code
npm run build

# "Publish" the package locally
npm link

Create an N8N installation and add the n8n-nodes-starter to it:

# Create an N8N installation
cd ..
mkdir n8n_install
cd n8n_install
npm init
npm install
npm install n8n

# "Install" the locally published module
npm link n8n-nodes-starter

# Start n8n
npx n8n

License

Apache 2.0 with Commons Clause