n8n-nodes-starter

This repo contains example nodes to help you get started building your own custom integrations for n8n. It includes the node linter and other dependencies.

To make your custom node available to the community, you must create it as an npm package, and submit it to the npm registry.

Prerequisites

You need the following installed on your development machine:

• git
• 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 here. For Windows users, refer to Microsoft's guide to Install NodeJS on Windows.
• Install n8n with:

  npm install n8n -g

• Recommended: follow n8n's guide to set up your development environment.

Using this starter

These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the documentation.

1. Generate a new repository from this template repository.
2. Clone your new repo:

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

3. Run npm i to install dependencies.
4. Open the project in your editor.
5. Browse the examples in /nodes and /credentials. Modify the examples, or replace them with your own nodes.
6. Update the package.json to match your details.
7. Run npm run lint to check for errors or npm run lintfix to automatically fix errors when possible.
8. Test your node locally. Refer to Run your node locally for guidance.
9. Replace this README with documentation for your node. Use the README_TEMPLATE to get started.
10. Update the LICENSE file to use your details.
11. Publish your package to npm.

More information

Refer to our documentation on creating nodes for detailed information on building your own nodes.

License

MIT

Start N8N

Security configuration using BASIC AUTH

# Basic Auth and User Passs
export N8N_BASIC_AUTH_ACTIVE=false
export N8N_BASIC_AUTH_USER=admin
export N8N_BASIC_AUTH_PASSWORD=pass
#---------------------------------------------------
export N8N_USER_MANAGEMENT_DISABLED=true
export EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS=true

Security configuration without login

export N8N_BASIC_AUTH_ACTIVE=false
export N8N_USER_MANAGEMENT_DISABLED=false

Network Configuration

Setup Server host in VM

export N8N_PROTOCOL=https
export N8N_HOST=localhost
export N8N_PORT=5678
export N8N_WEBHOOK = https://sarasa.com:443

Server -> NGNIX ->Webhooks localhost:5678 sarasa.com:443 sarasa.com:443/qwedqsdadwsdaw

Link this project to your n8n instance

First we need to link this project as a node global package using:

npm link

Now check if the link was successful:

npm list -g

This entry must appears: [email protected] -> ./../../../Users/ale/Workbook/n8n-nodes-coba

Then we need to link n8n to this project using: in windows C:\Users\jorlu\AppData\Roaming\npm\node_modules

cd /usr/local/lib/node_modules/n8n
npm link n8n-nodes-coba

Then n8n start -tunnel again

Link - shortcut

Just do this:

cd /usr/local/lib/node_modules/n8n
npm link /Users/ale/Workbook/n8n-nodes-coba

Tunnel issues

Sometimes --tunnel opion doesn't work, in that case we need to install localtunnel and use it to expose the port 5678

npm install -g localtunnel

	lt --port 5678

Then copy the url and use it in the webhook url

export WEBHOOK_URL = https://sarasa.com

Then run n8n start without the --tunnel option

NPM Publish

Right now its been published as a public packages in npmjs.com. To publish a new version just do:

npm version minor npm publish --access public

RaaS Partner SDK

This is a Node.js SDK for the RaaS Partner API. It provides a simple interface for interacting with the Remesas System. The package is published in npmjs.com as @leapfinancial/raas-partner-sdk

npm run build npm link n8n start --tunnel

Publish package using Github Actions

There is an action that will publish the package to npmjs.com when a new tag is created in github. To do that, just create a new tag in github and the action will do the rest automatically.

Recommended way to publish a new version

Before publishing the package, be sure your local repo is updated, and there is nothing left to commit, this is important couse npm version will fail if there is something left to commit. In order to increment package version we use npm version command, for example to increment:

• Use path for fixes: npm version patch
• Use minor version for new features: npm version minor
• Use mayor version for breaking changes, with not backward compatibility: npm version minor

This command will create a new tag in local repo. Then we need to push the tag to github. The --tags option will push all tags in local repo to github.

git push origin --tags