n8n-nodes-starter

This starter repository helps you build custom integrations for n8n. It includes example nodes, credentials, the node linter, and all the tooling you need to get started.

Quick Start

[!TIP]
New to building n8n nodes? The fastest way to get started is with npm create @n8n/node. This command scaffolds a complete node package for you using the @n8n/node-cli.

To create a new node package from scratch:

npm create @n8n/node

Already using this starter? Start developing with:

npm run dev

This starts n8n with your nodes loaded and hot reload enabled.

What's Included

This starter repository includes two example nodes to learn from:

• Example Node - A simple starter node that shows the basic structure with a custom execute method
• GitHub Issues Node - A complete, production-ready example built using the declarative style:

• Low-code approach - Define operations declaratively without writing request logic

• Multiple resources (Issues, Comments)

• Multiple operations (Get, Get All, Create)

• Two authentication methods (OAuth2 and Personal Access Token)

• List search functionality for dynamic dropdowns

• Proper error handling and typing

• Ideal for HTTP API-based integrations

[!TIP]
The declarative/low-code style (used in GitHub Issues) is the recommended approach for building nodes that interact with HTTP APIs. It significantly reduces boilerplate code and handles requests automatically.

Browse these examples to understand both approaches, then modify them or create your own.

Finding Inspiration

Looking for more examples? Check out these resources:

• npm Community Nodes - Browse thousands of community-built nodes on npm using the n8n-community-node-package tag
• n8n Built-in Nodes - Study the source code of n8n's official nodes for production-ready patterns and best practices
• n8n Credentials - See how authentication is implemented for various services

Prerequisites

Before you begin, install the following on your development machine:

Required

• Node.js (v22 or higher) and npm

• Linux/Mac/WSL: Install via nvm

• Windows: Follow Microsoft's NodeJS guide
• git

Recommended

• Follow n8n's development environment setup guide

[!NOTE]
The @n8n/node-cli is included as a dev dependency and will be installed automatically when you run npm install. The CLI includes n8n for local development, so you don't need to install n8n globally.

Getting Started with this Starter

Follow these steps to create your own n8n community node package:

1. Create Your Repository

Generate a new repository from this template, then clone it:

git clone https://github.com/<your-organization>/<your-repo-name>.git
cd <your-repo-name>

2. Install Dependencies

npm install

This installs all required dependencies including the @n8n/node-cli.

3. Explore the Examples

Browse the example nodes in nodes/ and credentials/ to understand the structure:

• Start with nodes/Example/ for a basic node
• Study nodes/GithubIssues/ for a real-world implementation

4. Build Your Node

Edit the example nodes to fit your use case, or create new node files by copying the structure from nodes/Example/.

[!TIP]
If you want to scaffold a completely new node package, use npm create @n8n/node to start fresh with the CLI's interactive generator.

5. Configure Your Package

Update package.json with your details:

• name - Your package name (must start with n8n-nodes-)
• author - Your name and email
• repository - Your repository URL
• description - What your node does

6. Develop and Test Locally

Start n8n with your node loaded:

npm run dev

This command runs n8n-node dev which:

• Builds your node with watch mode
• Starts n8n with your node available
• Automatically rebuilds when you make changes
• Opens n8n in your browser (usually http://localhost:5678)

[!NOTE]
Learn more about CLI commands in the @n8n/node-cli documentation.

7. Lint Your Code

Check for errors:

npm run lint

Auto-fix issues when possible:

npm run lint:fix

8. Build for Production

When ready to publish:

npm run build

This compiles your TypeScript code to the dist/ folder.

9. Prepare for Publishing

Before publishing:

• Update documentation: Replace this README with your node's documentation. Use READMETEMPLATE.md as a starting point.
• Update the LICENSE: Add your details to the LICENSE file.
• Test thoroughly: Ensure your node works in different scenarios.

npm publish