mirror of https://github.com/n8n-io/n8n.git synced 2024-09-20 14:57:31 -07:00

History

Jan Oberhauser 08cc01551c Add repository entry to package.json files		2019-06-23 12:50:36 +02:00
..
commands	Initial commit to release	2019-06-23 12:35:23 +02:00
config	Initial commit to release	2019-06-23 12:35:23 +02:00
src	Initial commit to release	2019-06-23 12:35:23 +02:00
index.ts	Initial commit to release	2019-06-23 12:35:23 +02:00
LICENSE	Initial commit to release	2019-06-23 12:35:23 +02:00
package.json	Add repository entry to package.json files	2019-06-23 12:50:36 +02:00
README.md	Initial commit to release	2019-06-23 12:35:23 +02:00
tsconfig.json	Initial commit to release	2019-06-23 12:35:23 +02:00
tslint.json	Initial commit to release	2019-06-23 12:35:23 +02:00

README.md

n8n - Workflow Automation Tool

n8n is a tool which allows to easily and fast automate different taks.

Is still in beta so can not guarantee that everything works perfectly. Also is there currently not much documentation. That will hopefully change soon.

Give n8n a spin

To simply spin up n8n to have a look and give it spin you can simply run:

npx n8n

It will then download everything which is needed and start n8n.

You can then access n8n by opening: http://localhost:5678

Installation

To fully install n8n globally execute:

npm install n8n -g

After the installation n8n can be started by simply typing in:

n8n

License

Apache 2.0 with Commons Clause

Development

When developing n8n can be started with npm run start:dev. It will then automatically restart n8n every time a file changes.