mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-11-09 22:24:05 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

[doc] add Development Cycle

Browse source
This commit is contained in:
Thomas LÉVEIL 2019-08-14 09:14:24 +02:00 committed by GitHub
parent 3b72f044ab
commit d73622b35d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
CONTRIBUTING.md
View file

@ -42,7 +42,10 @@ dependencies are installed and the packages get linked correctly. Here a short g
#### Build Tools #### Build Tools
The packages which n8n uses depend on a few build tools: That all the packages which n8n uses can be installed and compiled correctly
the essential build tools must be installed. This is probably already the case
for the most people but if you are totally new to development or just setting
up a new computer it is probably still missing.
Linux: Linux:
``` ```
@ -54,13 +57,12 @@ Windows:
npm install -g windows-build-tools npm install -g windows-build-tools
``` ```
#### lerna #### lerna
n8n is split up in different modules which are all in a single mono repository. n8n is split up in different modules which are all in a single mono repository.
To facilitate those modules management, [lerna](https://lerna.js.org) gets To make development as easy as possible does [lerna](https://lerna.js.org) get
used. It automatically sets up file-links between modules which depend on each used. It automatically sets up file-links between modules which depend on each
others. other.
So for the setup to work correctly lerna has to be installed globally like this: So for the setup to work correctly lerna has to be installed globally like this:
@ -103,3 +105,17 @@ To start n8n execute:
``` ```
npm run start npm run start
``` ```
## Development Cycle
While iterating on n8n modules' code, you can run `npm run watch` to automatically build your changes. This will alert you as soon as something gets broken.
1. `npm run watch`
1. hack, hack, hack
1. `npm run start`
1. test
### Test suite
TODO: how to run jest or other automated test tools