mirror of
https://github.com/n8n-io/n8n-nodes-starter.git
synced 2025-12-07 05:38:08 -06:00
chore: important files added
This commit is contained in:
parent
67ee5b8e80
commit
f36b4cf0d1
3 changed files with 152 additions and 5 deletions
42
README.md
42
README.md
|
|
@ -12,13 +12,45 @@ If you would like your node to be available on n8n cloud you can also [submit yo
|
|||
|
||||
You need the following installed on your development machine:
|
||||
|
||||
* [git](https://git-scm.com/downloads)
|
||||
* Node.js and npm. Minimum version Node 20. 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:
|
||||
* Docker and Docker Compose
|
||||
* NodeJS and npm
|
||||
|
||||
Once you have cloned the repository:
|
||||
|
||||
* Execute:
|
||||
```
|
||||
npm install n8n -g
|
||||
npm i
|
||||
```
|
||||
* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/).
|
||||
|
||||
To run the local n8n instance:
|
||||
|
||||
* Execute:
|
||||
```
|
||||
docker compose up -d
|
||||
```
|
||||
Now, n8n will run on http://localhost:5678.
|
||||
|
||||
When changes are made to the custom node code and you want to test it on the local instance:
|
||||
|
||||
* There is a script file called deploy-node.sh. Once executed, it will build the custom node code and deploy the Docker container. This file requires a few changes depending on the name that Docker gives to the container and the volumes:
|
||||
|
||||
* On line 24 of the script, you will see this line:
|
||||
```
|
||||
TARGET_DIR="/var/lib/docker/volumes/n8n-self-hosted_n8n_data/_data/custom/$PACKAGE_NAME"
|
||||
```
|
||||
|
||||
* Depending on the container volume name, "n8n-self-hosted_n8n_data" needs to be changed. To check the volume's name, execute:
|
||||
|
||||
```
|
||||
docker volume ls
|
||||
```
|
||||
|
||||
* On lines 56 and 59, "n8n-self-hosted-n8n-1" must be changed to match the name of the container for the n8n instance.
|
||||
|
||||
* Once these changes are made, execute the script:
|
||||
```
|
||||
./deploy-node.sh
|
||||
```
|
||||
|
||||
## Using this starter
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue