👀 Usage example

Usually all the nodes you need for a certain task are already included with n8n. They take care of the new additions via PR and, at some point, they get added to the core packages.

There is an alternative way that is creating an npm package with just the component you want to add and install it in the n8n instance you have, which is the recommended way for custom packages that are going to be used only in your context/company/environment.

So, if you already have a n8n instance running, you could jump to the installation part and follow the instructions.

Once it's installed, it will appear in the components palette, as any other component:

👍 How to install

Just go to your n8n instance, find the folder where n8n is installed (if you are using the standard Docker installation, it will probably be: /usr/local/lib/node_modules/n8n) and install the package as any other npm package:

• Npm: npm i @codelytv/n8n-nodes-twitch
• Yarn: yarn add @codelytv/n8n-nodes-twitch

If you want to create a custom Docker image to have it installed by default (that's what we do), you could use our Dockerfile as a base. Take a look at our custom docker image repo:

Simple Dockerfile for custom n8n image

👌 Codely Code Quality Standards

Publishing this package we are committing ourselves to the following code quality standards:

• 🤝 Respect Semantic Versioning: No breaking changes in patch or minor versions
• 🤏 No surprises in transitive dependencies: Use the bare minimum dependencies needed to meet the purpose
• 🎯 One specific purpose to meet without having to carry a bunch of unnecessary other utilities
• ✅ Tests as documentation and usage examples
• 📖 Well documented ReadMe showing how to install and use
• ⚖️ License favoring Open Source and collaboration