⚡️ n8n-clone

An open-source, self-hosted, node-based workflow automation tool, inspired by n8n.io.

---

🚀 Overview

n8n-clone allows you to connect different apps and services to automate repetitive tasks and build complex workflows without writing code. Think of it as a glue layer for your internet services, enabling you to chain together actions based on specific triggers (e.g., a new entry in a database, a received email, or a scheduled time).

Key Concepts

• Nodes: The building blocks of any workflow. A node can be a trigger (starts the workflow) or a function (performs an action, manipulates data, or connects to an external service).
• Workflows: A series of connected nodes that define a process.
• Self-Hosted: You maintain full control over your data and execution environment.

---

✨ Features

• Visual Workflow Editor: Drag-and-drop interface for connecting nodes and defining workflow logic.
• Extensive Integrations: Built-in nodes for popular services (e.g., Slack, GitHub, Google Sheets, databases). (Note: Initial version may have a smaller set of nodes, but the architecture supports expansion.)
• Data Manipulation: Powerful nodes for transforming, filtering, and aggregating data between services.
• Conditional Logic: Implement branching and looping within your workflows.
• Webhooks & Cron Triggers: Start workflows via external API calls or on a defined schedule.

---

🛠 Installation

You can run n8n-clone using Docker for the simplest setup.

Prerequisites

• Docker
• Docker Compose (recommended for production setup)

Using Docker Compose (Recommended)

1. Clone this repository:

   git clone [https://github.com/topteamOrg/n8n-clone.git](https://github.com/topteamOrg/n8n-clone.git)
   cd n8n-clone

2. Start the service:

   docker-compose up -d

3. Access the interface: Open your web browser and navigate to http://localhost:5678.

Manual Installation (Node.js)

1. Install dependencies:

   npm install

2. Run the application:

   npm run dev

---

🤝 Contributing

We welcome contributions! Whether you are fixing a bug, improving documentation, or developing a new node, your help is appreciated.

Ways to Contribute:

• Report Bugs: Open an issue on GitHub.
• Suggest Features: Open a discussion on GitHub.
• Submit Code: Fork the repository and submit a Pull Request. Please ensure your code adheres to the existing coding standards.

Developing New Nodes

If you'd like to create a node for a new service, follow the guide in the CONTRIBUTING.md file. The basic structure for a new node is located in the src/nodes/ directory.

---

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.