vikunja
/
n8n-vikunja-nodes
mirror of https://github.com/go-vikunja/n8n-vikunja-nodes
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat: update readme with dev instructions

This commit is contained in:
kolaente 2023-10-24 19:20:59 +02:00
parent ec7b25ab24
commit ab034a42f6
Signed by: konrad
GPG Key ID: F40E70337AB24C9B
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -7,11 +7,12 @@ Check out [our website](https://vikunja.io/) for more information.
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
[Installation](#installation)
[Operations](#operations)
[Credentials](#credentials)
[Compatibility](#compatibility)
[Resources](#resources)
* [Installation](#installation)
* [Operations](#operations)
* [Credentials](#credentials)
* [Compatibility](#compatibility)
* [Development](#development)
* [Resources](#resources)
## Installation
@ -36,6 +37,16 @@ Enter the API token created previously and the API url.
Tested with n8n Version 1.9.3.
## Development
You need npm and NodeJS installed.
* Install dependencies with `npm i`
* Build the node with `npm run build`
* Check for lint errors with `npm run lint` and fix them with `npm run lintfix`
* To release a new version in the npm registry, run `npm publish`
* To test the node, build the node with `npm run build`, then while in the project directory run `export N8N_CUSTOM_EXTENSIONS=$PWD8N_CUSTOM_EXTENSIONS=$PWD` and start n8n with the `n8n` command. You should now be able to find the node when searching for it.
## Resources
* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)