2019-06-23 13:35:23 +03:00
|
|
|
# n8n - Workflow Automation Tool
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-06-24 14:21:07 +03:00
|
|
|
n8n is a tool which allows to easily and fast automate different tasks.
|
2019-06-23 13:35:23 +03:00
|
|
|
|
2019-06-23 21:56:42 +03:00
|
|
|
<a href="https://n8n.io/n8n-screenshot.png"><img src="https://n8n.io/n8n-screenshot.png" width="550" alt="n8n.io - Screenshot"></a>
|
|
|
|
|
|
2019-06-23 13:35:23 +03:00
|
|
|
Is still in beta so can not guarantee that everything works perfectly. Also
|
|
|
|
|
is there currently not much documentation. That will hopefully change soon.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2019-06-24 14:21:07 +03:00
|
|
|
Information about how to install and use it can be found in the cli package [here](https://github.com/n8n-io/n8n/tree/master/packages/cli)
|
2019-06-23 13:35:23 +03:00
|
|
|
|
2019-06-24 14:21:07 +03:00
|
|
|
And information about how to run it in Docker [here](https://github.com/n8n-io/n8n/tree/master/docker/images/n8n)
|
2019-06-23 13:35:23 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Development Setup
|
|
|
|
|
|
|
|
|
|
1. Clone the repository
|
|
|
|
|
2. Go into repository folder
|
|
|
|
|
3. Run: `npm install`
|
|
|
|
|
4. Run: `npx lerna bootstrap --hoist`
|
|
|
|
|
5. Run: `npm run build` or `npx lerna exec npm run build` (if lerna is not installed)
|
|
|
|
|
|
|
|
|
|
## Start
|
|
|
|
|
|
|
|
|
|
Execute: `npm run start`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2019-06-24 14:21:07 +03:00
|
|
|
[Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md)
|
