2019-10-03 08:53:03 +02:00
# n8n-nodes-starter
2021-12-02 12:23:05 +02:00
2019-10-03 08:53:03 +02:00
2022-04-26 15:44:54 +03:00
Example starter module for custom n8n nodes. FriendGrid API example from the n8n documentation is used for this purpose.
This is a TEST node used as a template for node creation.
2019-10-03 08:53:03 +02:00
2022-04-26 15:44:54 +03:00
## Try it out with docker
The recommended way is using our docker image [Digital Boss' N8N custom nodes docker image ](https://hub.docker.com/r/digitalboss/n8n-custom-nodes )
## Another way to try it out
2021-12-09 16:18:06 +02:00
2022-02-01 14:02:19 +02:00
[N8N documentation on custom nodes ](https://docs.n8n.io/nodes/creating-nodes/create-n8n-nodes-module.html )
2022-04-21 18:00:44 +03:00
Clone the n8n-nodes-starter repository and execute:
2021-12-09 16:18:06 +02:00
```
2022-02-01 14:02:19 +02:00
# Install dependencies
2021-12-09 16:18:06 +02:00
npm install
2022-02-01 14:02:19 +02:00
# Build the code
2021-12-09 16:18:06 +02:00
npm run build
2022-02-01 14:02:19 +02:00
# "Publish" the package locally
2021-12-09 16:18:06 +02:00
npm link
```
2022-04-21 18:00:44 +03:00
Create an N8N installation and add the n8n-nodes-starter to it:
2021-12-09 16:18:06 +02:00
```
2022-02-01 14:02:19 +02:00
# Create an N8N installation
2021-12-09 16:18:06 +02:00
cd ..
mkdir n8n_install
cd n8n_install
npm init
npm install
npm install n8n
2022-02-01 14:02:19 +02:00
# "Install" the locally published module
2022-04-21 18:00:44 +03:00
npm link @digital -boss/n8n-nodes-starter
2022-02-01 14:02:19 +02:00
# Start n8n
2021-12-09 16:18:06 +02:00
npx n8n
```
2022-04-26 15:44:54 +03:00
# Latest functionality
Displayed the package version in the node description. For reference, you can check [genversion ](https://www.npmjs.com/package/genversion ).
2022-04-21 18:00:44 +03:00
# Contribution
To make this node even better, please let us know, [how you use it ](mailto:info@digital-north-consulting.com ). Commits are always welcome.
# Issues
If you have any issues, please [let us know on GitHub ](https://github.com/digital-boss/n8n-nodes-starter/issues ).
# About
Special thanks to [N8n nodemation ](https://n8n.io ) workflow automation by Jan Oberhauser.
Nodes by [digital-north-consulting.com ](https://digital-north-consulting.com ). For productive use and consulting on this, [contact us please ](mailto:info@digital-north-consulting.com ).
This node was updated with ❤️ by Valentina Lilova [valentina98 ](https://github.com/valentina98 )
2021-12-09 16:18:06 +02:00
2019-10-03 08:53:03 +02:00
## License
[Apache 2.0 with Commons Clause ](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/LICENSE.md )
2021-12-09 16:18:06 +02:00
2022-04-21 18:00:44 +03:00
