open-index/open-npm huggingface dataset:
npm package: @surense/n8n-nodes-surense
Description: n8n community node for integrating with the Surense API
Author: Chen Brilling
Latest version: 1.0.5

# n8n Custom Nodes – Surense

This project contains custom nodes for [n8n](https://n8n.io).

## Prerequisites

- [git](https://git-scm.com/downloads)
- Node.js >= 20 and npm ([nvm instructions](https://github.com/nvm-sh/nvm))
- Install n8n globally:

  ```bash
  npm install n8n -g
  ```

- Recommended: follow n8n's [development environment guide](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/)

## Local Installation (Mac/Linux)

Add to your shell config (`~/.zshrc` or `~/.bashrc`):

```bash
export N8N_CUSTOM_EXTENSIONS=/Users/rotemb/Desktop/n8n-nodes-surense/dist
```

Reload shell:

```bash
source ~/.zshrc
```

Start n8n:

```bash
n8n start
```

## Docker Installation

Example `docker-compose.yml`:

```yaml
version: '3.9'
services:
  n8n:
    image: n8nio/n8n
    ports:
      - '5678:5678'
    environment:
      - N8N_CUSTOM_EXTENSIONS=/home/node/.n8n/custom
    volumes:
      - /Users/rotemb/Desktop/n8n-nodes-surense/dist:/home/node/.n8n/custom
```

Run:

```bash
docker compose up -d
```

## Development

Build nodes:

```bash
npm run build
```

Start n8n:

```bash
n8n start
```

**Optional: Hot Reload**

Install nodemon:

```bash
npm install -D nodemon
```

Add to `package.json`:

```json
"scripts": {
  "dev:n8n": "nodemon --watch dist --ext js --exec 'n8n start'"
}
```

Run nodemon:

```bash
npm run dev:n8n
```

> Edit TypeScript files in `src/` while `npm run dev` watches and rebuilds them. n8n will restart whenever `dist/` changes.

## More Information

See n8n's [node creation documentation](https://docs.n8n.io/integrations/creating-nodes/) for details on building your own nodes.