generated from n8n-io/n8n-nodes-starter
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit ba1d993
Showing
23 changed files
with
14,308 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = tab | ||
indent_size = 2 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[package.json] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false | ||
|
||
[*.yml] | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
module.exports = { | ||
root: true, | ||
|
||
env: { | ||
browser: true, | ||
es6: true, | ||
node: true, | ||
}, | ||
|
||
parser: '@typescript-eslint/parser', | ||
parserOptions: { | ||
project: ['./tsconfig.json'], | ||
sourceType: 'module', | ||
extraFileExtensions: ['.json'], | ||
}, | ||
ignorePatterns: [ | ||
'.eslintrc.js', | ||
'**/*.js', | ||
'**/node_modules/**', | ||
'**/dist/**', | ||
], | ||
|
||
overrides: [ | ||
{ | ||
files: ['package.json'], | ||
plugins: ['eslint-plugin-n8n-nodes-base'], | ||
extends: ['plugin:n8n-nodes-base/community'], | ||
rules: { | ||
'n8n-nodes-base/community-package-json-name-still-default': 'off', | ||
} | ||
}, | ||
{ | ||
files: ['./credentials/**/*.ts'], | ||
plugins: ['eslint-plugin-n8n-nodes-base'], | ||
extends: ['plugin:n8n-nodes-base/credentials'], | ||
rules: { | ||
'n8n-nodes-base/cred-class-field-documentation-url-missing': 'off', | ||
'n8n-nodes-base/cred-class-field-documentation-url-miscased': 'off', | ||
}, | ||
}, | ||
{ | ||
files: ['./nodes/**/*.ts'], | ||
plugins: ['eslint-plugin-n8n-nodes-base'], | ||
extends: ['plugin:n8n-nodes-base/nodes'], | ||
rules: { | ||
'n8n-nodes-base/node-execute-block-missing-continue-on-fail': 'off', | ||
'n8n-nodes-base/node-resource-description-filename-against-convention': 'off', | ||
'n8n-nodes-base/node-param-fixed-collection-type-unsorted-items': 'off', | ||
'n8n-nodes-base/node-execute-block-operation-missing-singular-pairing': 'off', | ||
'n8n-nodes-base/node-execute-block-operation-missing-plural-pairing': 'off', | ||
}, | ||
}, | ||
], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
module.exports = { | ||
extends: "./.eslintrc.js", | ||
overrides: [ | ||
{ | ||
files: ['package.json'], | ||
plugins: ['eslint-plugin-n8n-nodes-base'], | ||
rules: { | ||
'n8n-nodes-base/community-package-json-name-still-default': 'error', | ||
}, | ||
}, | ||
], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
node_modules | ||
.DS_Store | ||
.tmp | ||
tmp | ||
dist | ||
npm-debug.log* | ||
yarn.lock | ||
.vscode/launch.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
module.exports = { | ||
/** | ||
* https://prettier.io/docs/en/options.html#semicolons | ||
*/ | ||
semi: true, | ||
|
||
/** | ||
* https://prettier.io/docs/en/options.html#trailing-commas | ||
*/ | ||
trailingComma: 'all', | ||
|
||
/** | ||
* https://prettier.io/docs/en/options.html#bracket-spacing | ||
*/ | ||
bracketSpacing: true, | ||
|
||
/** | ||
* https://prettier.io/docs/en/options.html#tabs | ||
*/ | ||
useTabs: true, | ||
|
||
/** | ||
* https://prettier.io/docs/en/options.html#tab-width | ||
*/ | ||
tabWidth: 2, | ||
|
||
/** | ||
* https://prettier.io/docs/en/options.html#arrow-function-parentheses | ||
*/ | ||
arrowParens: 'always', | ||
|
||
/** | ||
* https://prettier.io/docs/en/options.html#quotes | ||
*/ | ||
singleQuote: true, | ||
|
||
/** | ||
* https://prettier.io/docs/en/options.html#quote-props | ||
*/ | ||
quoteProps: 'as-needed', | ||
|
||
/** | ||
* https://prettier.io/docs/en/options.html#end-of-line | ||
*/ | ||
endOfLine: 'lf', | ||
|
||
/** | ||
* https://prettier.io/docs/en/options.html#print-width | ||
*/ | ||
printWidth: 100, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"recommendations": [ | ||
"dbaeumer.vscode-eslint", | ||
"EditorConfig.EditorConfig", | ||
"esbenp.prettier-vscode", | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright 2022 n8n | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies | ||
of the Software, and to permit persons to whom the Software is furnished to do | ||
so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
 | ||
|
||
# n8n-nodes-starter | ||
|
||
This repo contains example nodes to help you get started building your own custom integrations for [n8n](n8n.io). It includes the node linter and other dependencies. | ||
|
||
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). | ||
|
||
## Prerequisites | ||
|
||
You need the following installed on your development machine: | ||
|
||
* [git](https://git-scm.com/downloads) | ||
* Node.js and npm. Minimum version Node 16. 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: | ||
``` | ||
npm install n8n -g | ||
``` | ||
* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/). | ||
|
||
|
||
## Using this starter | ||
|
||
These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/). | ||
|
||
1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository. | ||
2. Clone your new repo: | ||
``` | ||
git clone https://github.com/<your organization>/<your-repo-name>.git | ||
``` | ||
3. Run `npm i` to install dependencies. | ||
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. | ||
6. Update the `package.json` to match your details. | ||
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. | ||
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. | ||
11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm. | ||
## 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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# n8n-nodes-_node-name_ | ||
|
||
This is an n8n community node. It lets you use _app/service name_ in your n8n workflows. | ||
|
||
_App/service name_ is _one or two sentences describing the service this node integrates with_. | ||
|
||
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform. | ||
|
||
[Installation](#installation) | ||
[Operations](#operations) | ||
[Credentials](#credentials) <!-- delete if no auth needed --> | ||
[Compatibility](#compatibility) | ||
[Usage](#usage) <!-- delete if not using this section --> | ||
[Resources](#resources) | ||
[Version history](#version-history) <!-- delete if not using this section --> | ||
|
||
## Installation | ||
|
||
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation. | ||
|
||
## Operations | ||
|
||
_List the operations supported by your node._ | ||
|
||
## Credentials | ||
|
||
_If users need to authenticate with the app/service, provide details here. You should include prerequisites (such as signing up with the service), available authentication methods, and how to set them up._ | ||
|
||
## Compatibility | ||
|
||
_State the minimum n8n version, as well as which versions you test against. You can also include any known version incompatibility issues._ | ||
|
||
## Usage | ||
|
||
_This is an optional section. Use it to help users with any difficult or confusing aspects of the node._ | ||
|
||
_By the time users are looking for community nodes, they probably already know n8n basics. But if you expect new users, you can link to the [Try it out](https://docs.n8n.io/try-it-out/) documentation to help them get started._ | ||
|
||
## Resources | ||
|
||
* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/) | ||
* _Link to app/service documentation._ | ||
|
||
## Version history | ||
|
||
_This is another optional section. If your node has multiple versions, include a short description of available versions and what changed, as well as any compatibility impact._ | ||
|
||
|
Oops, something went wrong.