n8n-nodes-starter/README.md

23 lines
1.1 KiB
Markdown
Raw Normal View History

2019-10-03 08:53:03 +02:00
# n8n-nodes-starter
2022-06-13 16:58:34 +01:00
This repo contains example nodes to help you get started building your own custom integrations for n8n.
2019-10-03 08:53:03 +02:00
2022-06-13 16:50:13 +01:00
All nodes are npm packages. 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).
2022-06-13 16:46:20 +01:00
## Using this starter
2019-10-03 08:53:03 +02:00
2022-06-13 16:46:20 +01:00
1. Clone the repo:
```
git clone https://github.com/n8n-io/n8n-nodes-starter.git
```
2022-07-11 11:04:05 +02:00
2. Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes.
3. Open the project in your editor.
4. Browse the examples in `/nodes`. Modify the examples, or replace them with your own nodes.
5. Update the `package.json` to match your details.
6. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible.
7. Publish your package to npm. More information on the links below.
2019-10-03 08:53:03 +02:00
## License
2022-06-17 13:54:14 -07:00
[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)