n8n – node installation

# Install {{packageName}}

## Try it out

### Community nodes
The recommended way to install a node in N8N is using the [Community nodes](https://docs.n8n.io/integrations/community-nodes/installation/) feature.

### With docker
Another way is using our docker image [Digital Boss' N8N custom nodes docker image](https://hub.docker.com/r/digitalboss/n8n-custom-nodes). It uses an environment variable to install custom nodes.

### Run the node locally
[N8N Guide on how to run a node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/#run-your-node-locallyN8)

Clone the {{packageName}} repository and execute:
```bash
# Install dependencies
npm install

# Build the code
npm run build

# Create symlink at your global node_modules cache
npm link
ls -la $(npm -g root) # check created link
```

Create an N8N installation and add the {{packageName}} to it:
```bash
# Create an N8N installation
cd ..
mkdir n8n-local
cd n8n-local
npm init -y
npm install --save-dev n8n

# "Install" the locally published module
npm link {{packageFullName}}

# Start n8n
npx n8n
```

## License

[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)