mirror of
https://github.com/n8n-io/n8n-nodes-starter.git
synced 2025-10-31 07:12:25 -05:00
25 lines
1.1 KiB
Markdown
25 lines
1.1 KiB
Markdown
# n8n-nodes-starter
|
|
|
|
This repo contains example nodes to help you get started building your own custom integrations for n8n.
|
|
|
|
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).
|
|
|
|
## Using this starter
|
|
|
|
1. Clone the repo:
|
|
```
|
|
git clone https://github.com/n8n-io/n8n-nodes-starter.git
|
|
```
|
|
2. Open the project in your editor.
|
|
3. Browse the examples in `/nodes`. Modify the examples, or replace them with your own nodes.
|
|
4. Update the `package.json` to match your details.
|
|
5. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible.
|
|
6. Publish your package to npm. More information on the links below.
|
|
|
|
## More information
|
|
|
|
Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes.
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)
|