mirror of
https://github.com/n8n-io/n8n-nodes-starter.git
synced 2025-10-29 06:22:24 -05:00
Compare commits
2 commits
9b8a6b7053
...
e863c55657
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e863c55657 |
||
|
|
c6c8bb68b2 |
2 changed files with 6 additions and 3 deletions
|
|
@ -6,12 +6,14 @@ This repo contains example nodes to help you get started building your own custo
|
||||||
|
|
||||||
To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
|
To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
|
||||||
|
|
||||||
|
If you would like your node to be available on n8n cloud you can also [submit your node for verification](https://docs.n8n.io/integrations/creating-nodes/deploy/submit-community-nodes/).
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
You need the following installed on your development machine:
|
You need the following installed on your development machine:
|
||||||
|
|
||||||
* [git](https://git-scm.com/downloads)
|
* [git](https://git-scm.com/downloads)
|
||||||
* Node.js and pnpm. Minimum version Node 20. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
|
* Node.js and npm. Minimum version Node 20. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
|
||||||
* Install n8n with:
|
* Install n8n with:
|
||||||
```
|
```
|
||||||
npm install n8n -g
|
npm install n8n -g
|
||||||
|
|
@ -31,7 +33,7 @@ These are the basic steps for working with the starter. For detailed guidance on
|
||||||
4. Open the project in your editor.
|
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.
|
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.
|
6. Update the `package.json` to match your details.
|
||||||
7. Run `npm lint` to check for errors or `npm lintfix` to automatically fix errors when possible.
|
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](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance.
|
8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance.
|
||||||
9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started.
|
9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started.
|
||||||
10. Update the LICENSE file to use your details.
|
10. Update the LICENSE file to use your details.
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ export class HttpBin implements INodeType {
|
||||||
description: INodeTypeDescription = {
|
description: INodeTypeDescription = {
|
||||||
displayName: 'HttpBin',
|
displayName: 'HttpBin',
|
||||||
name: 'httpBin',
|
name: 'httpBin',
|
||||||
icon: 'file:httpbin.svg',
|
icon: { light: 'file:httpbin.svg', dark: 'file:httpbin.svg' },
|
||||||
group: ['transform'],
|
group: ['transform'],
|
||||||
version: 1,
|
version: 1,
|
||||||
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
||||||
|
|
@ -15,6 +15,7 @@ export class HttpBin implements INodeType {
|
||||||
},
|
},
|
||||||
inputs: [NodeConnectionType.Main],
|
inputs: [NodeConnectionType.Main],
|
||||||
outputs: [NodeConnectionType.Main],
|
outputs: [NodeConnectionType.Main],
|
||||||
|
usableAsTool: true,
|
||||||
credentials: [
|
credentials: [
|
||||||
{
|
{
|
||||||
name: 'httpbinApi',
|
name: 'httpbinApi',
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue