|
1 | | - |
| 1 | +#n8n-nodes-lowcoder |
2 | 2 |
|
3 | | -#n8n-nodes-starter |
| 3 | + |
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 linterandother dependencies. |
| 5 | +[n8n](https://www.n8n.io) node to inetract with lowcoder appsandmoudules[Lowcoder](https://lowcoder.cloud/) |
6 | 6 |
|
7 | | -To make your custom node availabletothe 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 | +##Howtoinstall |
8 | 8 |
|
9 | | -##Prerequisites |
| 9 | +###Community Nodes (Recommended) |
10 | 10 |
|
11 | | -You need the following installed onyourdevelopment machine: |
| 11 | +For users on n8n v0.187+,yourinstance owner can install this node from[Community Nodes](https://docs.n8n.io/integrations/community-nodes/installation/). |
12 | 12 |
|
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/). |
| 13 | +1. Go to**Settings > Community Nodes**. |
| 14 | +2. Select**Install**. |
| 15 | +3. Enter`n8n-nodes-lowcoder` in**Enter npm package name**. |
| 16 | +4. Agree to the[risks](https://docs.n8n.io/integrations/community-nodes/risks/) of using community nodes: select**I understand the risks of installing unverified code from a public source**. |
| 17 | +5. Select**Install**. |
20 | 18 |
|
| 19 | +After installing the node, you can use it like any other node. n8n displays the node in search results in the**Nodes** panel. |
21 | 20 |
|
22 | | -##Using this starter |
| 21 | +###Manual installation |
23 | 22 |
|
24 | | -These are the basic steps for working withthestarter. For detailed guidance on creating and publishing nodes, refer to the[documentation](https://docs.n8n.io/integrations/creating-nodes/). |
| 23 | +To get started installthepackage in your n8n root directory: |
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. |
40 | | -
|
41 | | -## More information |
42 | | -
|
43 | | -Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes. |
44 | | -
|
45 | | -## License |
46 | | -
|
47 | | -[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md) |
| 25 | +`npm install n8n-nodes-lowcoder` |
