|
1 | | - |
| 1 | +# n8n-nodes-baserow-trigger |
2 | 2 |
|
3 | | -# n8n-nodes-starter |
| 3 | +This is an n8n community node. It lets you use Baserow to trigger workflows in n8n. |
4 | 4 |
|
5 | | -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. |
| 5 | +[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform. |
6 | 6 |
|
7 | | -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). |
| 7 | +[Installation](#installation) |
| 8 | +[Credentials](#credentials) <!-- delete if no auth needed --> |
| 9 | +[Compatibility](#compatibility) |
| 10 | +[Resources](#resources) |
| 11 | +[Version history](#version-history) <!-- delete if not using this section --> |
8 | 12 |
|
9 | | -## Prerequisites |
| 13 | +## Installation |
10 | 14 |
|
11 | | -You need the following installed on your development machine: |
| 15 | +Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation. |
12 | 16 |
|
13 | | -* [git](https://git-scm.com/downloads) |
14 | | -* 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). |
15 | | -* Install n8n with: |
16 | | - ``` |
17 | | - npm install n8n -g |
18 | | - ``` |
19 | | -* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/). |
| 17 | +## Credentials |
20 | 18 |
|
| 19 | +This node uses the existing n8n Baserow credentials. |
21 | 20 |
|
22 | | -## Using this starter |
| 21 | +## Compatibility |
23 | 22 |
|
24 | | -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/). |
| 23 | +This node has been tested with n8n 0.208.1 and both Self hosted and Baserow hosted instances. |
25 | 24 |
|
26 | | -1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository. |
27 | | -2. Clone your new repo: |
28 | | - ``` |
29 | | - git clone https://github.com/<your organization>/<your-repo-name>.git |
30 | | - ``` |
31 | | -3. Run `npm i` to install dependencies. |
32 | | -4. Open the project in your editor. |
33 | | -5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes. |
34 | | -6. Update the `package.json` to match your details. |
35 | | -7. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible. |
36 | | -8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance. |
37 | | -9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started. |
38 | | -10. Update the LICENSE file to use your details. |
39 | | -11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm. |
| 25 | +## Resources |
40 | 26 |
|
41 | | -## More information |
| 27 | +* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/) |
42 | 28 |
|
43 | | -Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes. |
| 29 | +## Version history |
44 | 30 |
|
45 | | -## License |
46 | | -
|
47 | | -[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md) |
| 31 | +0.1.0 - Initial Release |
0 commit comments