mirrors/n8n-docs
2
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
1f58dbea4e
n8n-docs/docs/integrations/creating-nodes/build/node-development-environment.md
Deborah Barnard b8a4d063c9 add contentType to rest(?) of pages
2023-07-18 16:11:46 +01:00

1.7 KiB
Raw Blame History

contentType
howto

Set up your development environment

This document lists the essential dependencies for developing a node, as well as guidance on setting up your editor.

Requirements

To build and test a node, you need:

  • Node.js and npm. Minimum version Node 16. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL (Windows Subsystem for Linux) here{:target=_blank class=.external-link}. For Windows users, refer to Microsoft's guide to Install NodeJS on Windows{:target=_blank class=.external-link}.
  • A local instance of n8n. You can install n8n with npm install n8n -g, then follow the steps in Run your node locally to test your node.

You should also have git{:target=_blank class=.external-link} installed. This allows you to clone and use the n8n-node-starter{:target=_blank class=.external-link}.

Editor setup

n8n recommends using VS Code{:target=_blank class=.external-link} as your editor.

Install these extensions:

  • ESLint{:target=_blank class=.external-link}
  • EditorConfig{:target=_blank class=.external-link}
  • Prettier{:target=_blank class=.external-link}

By using VS Code and these extensions, you get access to the n8n node linter's warnings as you code.