mirror of
https://github.com/Zie619/n8n-workflows.git
synced 2025-11-25 03:15:25 +08:00
Updated readme and added the mit license
Some checks failed
CI/CD Pipeline / Run Tests (3.10) (push) Has been cancelled
CI/CD Pipeline / Run Tests (3.11) (push) Has been cancelled
CI/CD Pipeline / Run Tests (3.9) (push) Has been cancelled
CI/CD Pipeline / Security Scan (push) Has been cancelled
CI/CD Pipeline / Build and Push Docker Image (push) Has been cancelled
CI/CD Pipeline / Deploy to Staging (push) Has been cancelled
CI/CD Pipeline / Deploy to Production (push) Has been cancelled
CI/CD Pipeline / Send Notifications (push) Has been cancelled
Docker Build and Test / Build and Test Docker Image (push) Has been cancelled
Docker Build and Test / Test Multi-platform Build (push) Has been cancelled
Deploy to GitHub Pages / deploy (push) Has been cancelled
Deploy GitHub Pages / build (push) Has been cancelled
Update README Stats / update-stats (push) Has been cancelled
Deploy GitHub Pages / deploy (push) Has been cancelled
Some checks failed
CI/CD Pipeline / Run Tests (3.10) (push) Has been cancelled
CI/CD Pipeline / Run Tests (3.11) (push) Has been cancelled
CI/CD Pipeline / Run Tests (3.9) (push) Has been cancelled
CI/CD Pipeline / Security Scan (push) Has been cancelled
CI/CD Pipeline / Build and Push Docker Image (push) Has been cancelled
CI/CD Pipeline / Deploy to Staging (push) Has been cancelled
CI/CD Pipeline / Deploy to Production (push) Has been cancelled
CI/CD Pipeline / Send Notifications (push) Has been cancelled
Docker Build and Test / Build and Test Docker Image (push) Has been cancelled
Docker Build and Test / Test Multi-platform Build (push) Has been cancelled
Deploy to GitHub Pages / deploy (push) Has been cancelled
Deploy GitHub Pages / build (push) Has been cancelled
Update README Stats / update-stats (push) Has been cancelled
Deploy GitHub Pages / deploy (push) Has been cancelled
This commit is contained in:
zie619
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2025 Zie619
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
630
README.md
630
README.md
@@ -1,502 +1,274 @@
|
|||||||
# ⚡ N8N Workflow Collection & Documentation
|
# 🚀 n8n Workflow Collection
|
||||||
|
|
||||||
A professionally organized collection of **2,057 n8n workflows** with a lightning-fast documentation system that provides instant search, analysis, and browsing capabilities.
|
<div align="center">
|
||||||
|
|
||||||
> **⚠️ IMPORTANT NOTICE (Aug 14, 2025):** Repository history has been rewritten due to DMCA compliance. If you have a fork or local clone, please see [Issue 85](https://github.com/Zie619/n8n-workflows/issues/85) for instructions on syncing your copy.
|
|
||||||
>
|
|
||||||
## Support My Work
|
|
||||||
|
|
||||||
|
[](https://www.buymeacoffee.com/zie619)
|
||||||
|
|
||||||
[](https://www.buymeacoffee.com/zie619)
|
### 🌟 The Ultimate Collection of n8n Automation Workflows
|
||||||
|
|
||||||
If you'd like to say thanks, consider buying me a coffee—your support helps me keep improving this project!
|
**[🔍 Browse Online](https://zie619.github.io/n8n-workflows)** • **[📚 Documentation](#documentation)** • **[🤝 Contributing](#contributing)** • **[📄 License](#license)**
|
||||||
|
|
||||||
## 🚀 **NEW: Public Search Interface & High-Performance Documentation**
|
</div>
|
||||||
|
|
||||||
**🌐 [Browse workflows online](https://zie619.github.io/n8n-workflows) - No installation required!**
|
---
|
||||||
|
|
||||||
**Or run locally for development with 100x performance improvement:**
|
## ✨ What's New
|
||||||
|
|
||||||
### Option 1: Online Search (Recommended for Users)
|
### 🎉 Latest Updates (November 2025)
|
||||||
**🔗 Visit: [zie619.github.io/n8n-workflows](https://zie619.github.io/n8n-workflows)**
|
- **🔒 Enhanced Security**: Full security audit completed, all CVEs resolved
|
||||||
- ⚡ **Instant access** - No setup required
|
- **🐳 Docker Support**: Multi-platform builds for linux/amd64 and linux/arm64
|
||||||
- 🔍 **Search 2,057+ workflows** directly in browser
|
- **📊 GitHub Pages**: Live searchable interface at [zie619.github.io/n8n-workflows](https://zie619.github.io/n8n-workflows)
|
||||||
- 📱 **Mobile-friendly** interface
|
- **⚡ Performance**: 100x faster search with SQLite FTS5 integration
|
||||||
- 🏷️ **Category filtering** across 15 categories
|
- **🎨 Modern UI**: Completely redesigned interface with dark/light mode
|
||||||
- 📥 **Direct download** of workflow JSON files
|
|
||||||
|
|
||||||
### Option 2: Local Development System
|
---
|
||||||
|
|
||||||
|
## 🌐 Quick Access
|
||||||
|
|
||||||
|
### 🔥 Use Online (No Installation)
|
||||||
|
Visit **[zie619.github.io/n8n-workflows](https://zie619.github.io/n8n-workflows)** for instant access to:
|
||||||
|
- 🔍 **Smart Search** - Find workflows instantly
|
||||||
|
- 📂 **15+ Categories** - Browse by use case
|
||||||
|
- 📱 **Mobile Ready** - Works on any device
|
||||||
|
- ⬇️ **Direct Downloads** - Get workflow JSONs instantly
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Features
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<td width="50%">
|
||||||
|
|
||||||
|
### 📊 By The Numbers
|
||||||
|
- **2,057** Production-Ready Workflows
|
||||||
|
- **365** Unique Integrations
|
||||||
|
- **29,445** Total Nodes
|
||||||
|
- **15** Organized Categories
|
||||||
|
- **100%** Import Success Rate
|
||||||
|
|
||||||
|
</td>
|
||||||
|
<td width="50%">
|
||||||
|
|
||||||
|
### ⚡ Performance
|
||||||
|
- **< 100ms** Search Response
|
||||||
|
- **< 50MB** Memory Usage
|
||||||
|
- **700x** Smaller Than v1
|
||||||
|
- **10x** Faster Load Times
|
||||||
|
- **40x** Less RAM Usage
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 💻 Local Installation
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
- Python 3.9+
|
||||||
|
- pip (Python package manager)
|
||||||
|
- 100MB free disk space
|
||||||
|
|
||||||
|
### Quick Start
|
||||||
```bash
|
```bash
|
||||||
|
# Clone the repository
|
||||||
|
git clone https://github.com/Zie619/n8n-workflows.git
|
||||||
|
cd n8n-workflows
|
||||||
|
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
|
||||||
# Start the fast API server
|
# Start the server
|
||||||
python run.py
|
python run.py
|
||||||
|
|
||||||
# Open in browser
|
# Open in browser
|
||||||
http://localhost:8000
|
# http://localhost:8000
|
||||||
```
|
```
|
||||||
|
|
||||||
**Features:**
|
### 🐳 Docker Installation
|
||||||
- ⚡ **Sub-100ms response times** with SQLite FTS5 search
|
|
||||||
- 🔍 **Instant full-text search** with advanced filtering
|
|
||||||
- 📱 **Responsive design** - works perfectly on mobile
|
|
||||||
- 🌙 **Dark/light themes** with system preference detection
|
|
||||||
- 📊 **Live statistics** - 365 unique integrations, 29,445 total nodes
|
|
||||||
- 🎯 **Smart categorization** by trigger type and complexity
|
|
||||||
- 🎯 **Use case categorization** by service name mapped to categories
|
|
||||||
- 📄 **On-demand JSON viewing** and download
|
|
||||||
- 🔗 **Mermaid diagram generation** for workflow visualization
|
|
||||||
- 🔄 **Real-time workflow naming** with intelligent formatting
|
|
||||||
|
|
||||||
### Performance Comparison
|
|
||||||
|
|
||||||
| Metric | Old System | New System | Improvement |
|
|
||||||
|--------|------------|------------|-------------|
|
|
||||||
| **File Size** | 71MB HTML | <100KB | **700x smaller** |
|
|
||||||
| **Load Time** | 10+ seconds | <1 second | **10x faster** |
|
|
||||||
| **Search** | Client-side only | Full-text with FTS5 | **Instant** |
|
|
||||||
| **Memory Usage** | ~2GB RAM | <50MB RAM | **40x less** |
|
|
||||||
| **Mobile Support** | Poor | Excellent | **Fully responsive** |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📂 Repository Organization
|
|
||||||
|
|
||||||
### Workflow Collection
|
|
||||||
- **2,057 workflows** with meaningful, searchable names
|
|
||||||
- **365 unique integrations** across popular platforms
|
|
||||||
- **29,445 total nodes** with professional categorization
|
|
||||||
- **Quality assurance** - All workflows analyzed and categorized
|
|
||||||
|
|
||||||
### Advanced Naming System ✨
|
|
||||||
Our intelligent naming system converts technical filenames into readable titles:
|
|
||||||
- **Before**: `2051_Telegram_Webhook_Automation_Webhook.json`
|
|
||||||
- **After**: `Telegram Webhook Automation`
|
|
||||||
- **100% meaningful names** with smart capitalization
|
|
||||||
- **Automatic integration detection** from node analysis
|
|
||||||
|
|
||||||
### Use Case Category ✨
|
|
||||||
|
|
||||||
The search interface includes a dropdown filter that lets you browse 2,057+ workflows by category.
|
|
||||||
|
|
||||||
The system includes an automated categorization feature that organizes workflows by service categories to make them easier to discover and filter.
|
|
||||||
|
|
||||||
### How Categorization Works
|
|
||||||
|
|
||||||
1. **Run the categorization script**
|
|
||||||
```
|
|
||||||
python create_categories.py
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Service Name Recognition**
|
|
||||||
The script analyzes each workflow JSON filename to identify recognized service names (e.g., "Twilio", "Slack", "Gmail", etc.)
|
|
||||||
|
|
||||||
3. **Category Mapping**
|
|
||||||
Each recognized service name is matched to its corresponding category using the definitions in `context/def_categories.json`. For example:
|
|
||||||
- Twilio → Communication & Messaging
|
|
||||||
- Gmail → Communication & Messaging
|
|
||||||
- Airtable → Data Processing & Analysis
|
|
||||||
- Salesforce → CRM & Sales
|
|
||||||
|
|
||||||
4. **Search Categories Generation**
|
|
||||||
The script produces a `search_categories.json` file that contains the categorized workflow data
|
|
||||||
|
|
||||||
5. **Filter Interface**
|
|
||||||
Users can then filter workflows by category in the search interface, making it easier to find workflows for specific use cases
|
|
||||||
|
|
||||||
### Available Categories
|
|
||||||
|
|
||||||
The categorization system includes the following main categories:
|
|
||||||
- AI Agent Development
|
|
||||||
- Business Process Automation
|
|
||||||
- Cloud Storage & File Management
|
|
||||||
- Communication & Messaging
|
|
||||||
- Creative Content & Video Automation
|
|
||||||
- Creative Design Automation
|
|
||||||
- CRM & Sales
|
|
||||||
- Data Processing & Analysis
|
|
||||||
- E-commerce & Retail
|
|
||||||
- Financial & Accounting
|
|
||||||
- Marketing & Advertising Automation
|
|
||||||
- Project Management
|
|
||||||
- Social Media Management
|
|
||||||
- Technical Infrastructure & DevOps
|
|
||||||
- Web Scraping & Data Extraction
|
|
||||||
|
|
||||||
### Contribute Categories
|
|
||||||
|
|
||||||
You can help expand the categorization by adding more service-to-category mappings (e.g., Twilio → Communication & Messaging) in context/defs_categories.json.
|
|
||||||
|
|
||||||
Many workflow JSON files are conveniently named with the service name, often separated by underscores (_).
|
|
||||||
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🛠 Usage Instructions
|
|
||||||
|
|
||||||
### Option 1: Modern Fast System (Recommended)
|
|
||||||
```bash
|
```bash
|
||||||
# Clone repository
|
# Using Docker Hub
|
||||||
git clone <repo-url>
|
docker run -p 8000:8000 zie619/n8n-workflows:latest
|
||||||
cd n8n-workflows
|
|
||||||
|
|
||||||
# Install Python dependencies
|
# Or build locally
|
||||||
pip install -r requirements.txt
|
docker build -t n8n-workflows .
|
||||||
|
docker run -p 8000:8000 n8n-workflows
|
||||||
# Start the documentation server
|
|
||||||
python run.py
|
|
||||||
|
|
||||||
# Browse workflows at http://localhost:8000
|
|
||||||
# - Instant search across 2,057 workflows
|
|
||||||
# - Professional responsive interface
|
|
||||||
# - Real-time workflow statistics
|
|
||||||
```
|
|
||||||
|
|
||||||
### Option 2: Development Mode
|
|
||||||
```bash
|
|
||||||
# Start with auto-reload for development
|
|
||||||
python run.py --dev
|
|
||||||
|
|
||||||
# Or specify custom host/port
|
|
||||||
python run.py --host 0.0.0.0 --port 3000
|
|
||||||
|
|
||||||
# Force database reindexing
|
|
||||||
python run.py --reindex
|
|
||||||
```
|
|
||||||
|
|
||||||
### Import Workflows into n8n
|
|
||||||
```bash
|
|
||||||
# Use the Python importer (recommended)
|
|
||||||
python import_workflows.py
|
|
||||||
|
|
||||||
# Or manually import individual workflows:
|
|
||||||
# 1. Open your n8n Editor UI
|
|
||||||
# 2. Click menu (☰) → Import workflow
|
|
||||||
# 3. Choose any .json file from the workflows/ folder
|
|
||||||
# 4. Update credentials/webhook URLs before running
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📊 Workflow Statistics
|
## 📚 Documentation
|
||||||
|
|
||||||
### Current Collection Stats
|
### API Endpoints
|
||||||
- **Total Workflows**: 2,057 automation workflows
|
|
||||||
- **Active Workflows**: 215 (10.5% active rate)
|
|
||||||
- **Total Nodes**: 29,528 (avg 14.4 nodes per workflow)
|
|
||||||
- **Unique Integrations**: 367 different services and APIs
|
|
||||||
- **Database**: SQLite with FTS5 full-text search
|
|
||||||
|
|
||||||
### Trigger Distribution
|
| Endpoint | Method | Description |
|
||||||
- **Complex**: 832 workflows (40.4%) - Multi-trigger systems
|
|----------|--------|-------------|
|
||||||
- **Webhook**: 521 workflows (25.3%) - API-triggered automations
|
| `/` | GET | Web interface |
|
||||||
- **Manual**: 478 workflows (23.2%) - User-initiated workflows
|
| `/api/search` | GET | Search workflows |
|
||||||
- **Scheduled**: 226 workflows (11.0%) - Time-based executions
|
| `/api/stats` | GET | Repository statistics |
|
||||||
|
| `/api/workflow/{id}` | GET | Get workflow JSON |
|
||||||
|
| `/api/categories` | GET | List all categories |
|
||||||
|
| `/api/export` | GET | Export workflows |
|
||||||
|
|
||||||
### Complexity Analysis
|
### Search Features
|
||||||
- **Low (≤5 nodes)**: ~35% - Simple automations
|
- **Full-text search** across names, descriptions, and nodes
|
||||||
- **Medium (6-15 nodes)**: ~45% - Standard workflows
|
- **Category filtering** (Marketing, Sales, DevOps, etc.)
|
||||||
- **High (16+ nodes)**: ~20% - Complex enterprise systems
|
- **Complexity filtering** (Low, Medium, High)
|
||||||
|
- **Trigger type filtering** (Webhook, Schedule, Manual, etc.)
|
||||||
### Popular Integrations
|
- **Service filtering** (365+ integrations)
|
||||||
Top services by usage frequency:
|
|
||||||
- **Communication**: Telegram, Discord, Slack, WhatsApp
|
|
||||||
- **Cloud Storage**: Google Drive, Google Sheets, Dropbox
|
|
||||||
- **Databases**: PostgreSQL, MySQL, MongoDB, Airtable
|
|
||||||
- **AI/ML**: OpenAI, Anthropic, Hugging Face
|
|
||||||
- **Development**: HTTP Request, Webhook, GraphQL
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🔍 Advanced Search Features
|
## 🏗️ Architecture
|
||||||
|
|
||||||
### Smart Search Categories
|
```mermaid
|
||||||
Our system automatically categorizes workflows into 15 main categories:
|
graph LR
|
||||||
|
A[User] --> B[Web Interface]
|
||||||
#### Available Categories:
|
B --> C[FastAPI Server]
|
||||||
- **AI Agent Development**: OpenAI, Anthropic, Hugging Face, CalcsLive
|
C --> D[SQLite FTS5]
|
||||||
- **Business Process Automation**: Workflow utilities, scheduling, data processing
|
D --> E[Workflow Database]
|
||||||
- **Cloud Storage & File Management**: Google Drive, Dropbox, OneDrive, Box
|
C --> F[Static Files]
|
||||||
- **Communication & Messaging**: Telegram, Discord, Slack, WhatsApp, Email
|
F --> G[Workflow JSONs]
|
||||||
- **Creative Content & Video Automation**: YouTube, Vimeo, content creation
|
|
||||||
- **Creative Design Automation**: Canva, Figma, image processing
|
|
||||||
- **CRM & Sales**: Salesforce, HubSpot, Pipedrive, customer management
|
|
||||||
- **Data Processing & Analysis**: Database operations, analytics, data transformation
|
|
||||||
- **E-commerce & Retail**: Shopify, Stripe, PayPal, online stores
|
|
||||||
- **Financial & Accounting**: Financial tools, payment processing, accounting
|
|
||||||
- **Marketing & Advertising Automation**: Email marketing, campaigns, lead generation
|
|
||||||
- **Project Management**: Jira, Trello, Asana, task management
|
|
||||||
- **Social Media Management**: LinkedIn, Twitter/X, Facebook, Instagram
|
|
||||||
- **Technical Infrastructure & DevOps**: GitHub, deployment, monitoring
|
|
||||||
- **Web Scraping & Data Extraction**: HTTP requests, webhooks, data collection
|
|
||||||
|
|
||||||
### API Usage Examples
|
|
||||||
```bash
|
|
||||||
# Search workflows by text
|
|
||||||
curl "http://localhost:8000/api/workflows?q=telegram+automation"
|
|
||||||
|
|
||||||
# Filter by trigger type and complexity
|
|
||||||
curl "http://localhost:8000/api/workflows?trigger=Webhook&complexity=high"
|
|
||||||
|
|
||||||
# Find all messaging workflows
|
|
||||||
curl "http://localhost:8000/api/workflows/category/messaging"
|
|
||||||
|
|
||||||
# Get database statistics
|
|
||||||
curl "http://localhost:8000/api/stats"
|
|
||||||
|
|
||||||
# Browse available categories
|
|
||||||
curl "http://localhost:8000/api/categories"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Tech Stack
|
||||||
|
- **Backend**: Python, FastAPI, SQLite with FTS5
|
||||||
|
- **Frontend**: Vanilla JS, Tailwind CSS
|
||||||
|
- **Database**: SQLite with Full-Text Search
|
||||||
|
- **Deployment**: Docker, GitHub Actions, GitHub Pages
|
||||||
|
- **Security**: Trivy scanning, CORS protection, Input validation
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🏗 Technical Architecture
|
## 📂 Repository Structure
|
||||||
|
|
||||||
### Modern Stack
|
|
||||||
- **SQLite Database** - FTS5 full-text search with 365 indexed integrations
|
|
||||||
- **FastAPI Backend** - RESTful API with automatic OpenAPI documentation
|
|
||||||
- **Responsive Frontend** - Modern HTML5 with embedded CSS/JavaScript
|
|
||||||
- **Smart Analysis** - Automatic workflow categorization and naming
|
|
||||||
|
|
||||||
### Key Features
|
|
||||||
- **Change Detection** - MD5 hashing for efficient re-indexing
|
|
||||||
- **Background Processing** - Non-blocking workflow analysis
|
|
||||||
- **Compressed Responses** - Gzip middleware for optimal speed
|
|
||||||
- **Error Handling** - Graceful degradation and comprehensive logging
|
|
||||||
- **Mobile Optimization** - Touch-friendly interface design
|
|
||||||
|
|
||||||
### Database Performance
|
|
||||||
```sql
|
|
||||||
-- Optimized schema for lightning-fast queries
|
|
||||||
CREATE TABLE workflows (
|
|
||||||
id INTEGER PRIMARY KEY,
|
|
||||||
filename TEXT UNIQUE,
|
|
||||||
name TEXT,
|
|
||||||
active BOOLEAN,
|
|
||||||
trigger_type TEXT,
|
|
||||||
complexity TEXT,
|
|
||||||
node_count INTEGER,
|
|
||||||
integrations TEXT, -- JSON array of 365 unique services
|
|
||||||
description TEXT,
|
|
||||||
file_hash TEXT, -- MD5 for change detection
|
|
||||||
analyzed_at TIMESTAMP
|
|
||||||
);
|
|
||||||
|
|
||||||
-- Full-text search with ranking
|
|
||||||
CREATE VIRTUAL TABLE workflows_fts USING fts5(
|
|
||||||
filename, name, description, integrations, tags,
|
|
||||||
content='workflows', content_rowid='id'
|
|
||||||
);
|
|
||||||
```
|
```
|
||||||
|
n8n-workflows/
|
||||||
---
|
├── workflows/ # 2,057 workflow JSON files
|
||||||
|
│ └── [category]/ # Organized by integration
|
||||||
## 🔧 Setup & Requirements
|
├── docs/ # GitHub Pages site
|
||||||
|
├── src/ # Python source code
|
||||||
### System Requirements
|
├── scripts/ # Utility scripts
|
||||||
- **Python 3.7+** - For running the documentation system
|
├── api_server.py # FastAPI application
|
||||||
- **Modern Browser** - Chrome, Firefox, Safari, Edge
|
├── run.py # Server launcher
|
||||||
- **50MB Storage** - For SQLite database and indexes
|
├── workflow_db.py # Database manager
|
||||||
- **n8n Instance** - For importing and running workflows
|
└── requirements.txt # Python dependencies
|
||||||
|
|
||||||
### Installation
|
|
||||||
```bash
|
|
||||||
# Clone repository
|
|
||||||
git clone <repo-url>
|
|
||||||
cd n8n-workflows
|
|
||||||
|
|
||||||
# Install dependencies
|
|
||||||
pip install -r requirements.txt
|
|
||||||
|
|
||||||
# Start documentation server
|
|
||||||
python run.py
|
|
||||||
|
|
||||||
# Access at http://localhost:8000
|
|
||||||
```
|
|
||||||
|
|
||||||
### Development Setup
|
|
||||||
```bash
|
|
||||||
# Create virtual environment
|
|
||||||
python3 -m venv .venv
|
|
||||||
source .venv/bin/activate # Linux/Mac
|
|
||||||
# or .venv\Scripts\activate # Windows
|
|
||||||
|
|
||||||
# Install dependencies
|
|
||||||
pip install -r requirements.txt
|
|
||||||
|
|
||||||
# Run with auto-reload for development
|
|
||||||
python api_server.py --reload
|
|
||||||
|
|
||||||
# Force database reindexing
|
|
||||||
python workflow_db.py --index --force
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📋 Naming Convention
|
|
||||||
|
|
||||||
### Intelligent Formatting System
|
|
||||||
Our system automatically converts technical filenames to user-friendly names:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Automatic transformations:
|
|
||||||
2051_Telegram_Webhook_Automation_Webhook.json → "Telegram Webhook Automation"
|
|
||||||
0250_HTTP_Discord_Import_Scheduled.json → "HTTP Discord Import Scheduled"
|
|
||||||
0966_OpenAI_Data_Processing_Manual.json → "OpenAI Data Processing Manual"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Technical Format
|
|
||||||
```
|
|
||||||
[ID]_[Service1]_[Service2]_[Purpose]_[Trigger].json
|
|
||||||
```
|
|
||||||
|
|
||||||
### Smart Capitalization Rules
|
|
||||||
- **HTTP** → HTTP (not Http)
|
|
||||||
- **API** → API (not Api)
|
|
||||||
- **webhook** → Webhook
|
|
||||||
- **automation** → Automation
|
|
||||||
- **scheduled** → Scheduled
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🚀 API Documentation
|
|
||||||
|
|
||||||
### Core Endpoints
|
|
||||||
- `GET /` - Main workflow browser interface
|
|
||||||
- `GET /api/stats` - Database statistics and metrics
|
|
||||||
- `GET /api/workflows` - Search with filters and pagination
|
|
||||||
- `GET /api/workflows/{filename}` - Detailed workflow information
|
|
||||||
- `GET /api/workflows/{filename}/download` - Download workflow JSON
|
|
||||||
- `GET /api/workflows/{filename}/diagram` - Generate Mermaid diagram
|
|
||||||
|
|
||||||
### Advanced Search
|
|
||||||
- `GET /api/workflows/category/{category}` - Search by service category
|
|
||||||
- `GET /api/categories` - List all available categories
|
|
||||||
- `GET /api/integrations` - Get integration statistics
|
|
||||||
- `POST /api/reindex` - Trigger background reindexing
|
|
||||||
|
|
||||||
### Response Examples
|
|
||||||
```json
|
|
||||||
// GET /api/stats
|
|
||||||
{
|
|
||||||
"total": 2053,
|
|
||||||
"active": 215,
|
|
||||||
"inactive": 1838,
|
|
||||||
"triggers": {
|
|
||||||
"Complex": 831,
|
|
||||||
"Webhook": 519,
|
|
||||||
"Manual": 477,
|
|
||||||
"Scheduled": 226
|
|
||||||
},
|
|
||||||
"total_nodes": 29445,
|
|
||||||
"unique_integrations": 365
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🤝 Contributing
|
## 🤝 Contributing
|
||||||
|
|
||||||
**🎉 This project solves [Issue #84](https://github.com/Zie619/n8n-workflows/issues/84) - providing online access to workflows without requiring local setup!**
|
We love contributions! Here's how you can help:
|
||||||
|
|
||||||
### Adding New Workflows
|
### Ways to Contribute
|
||||||
1. **Export workflow** as JSON from n8n
|
- 🐛 **Report bugs** via [Issues](https://github.com/Zie619/n8n-workflows/issues)
|
||||||
2. **Name descriptively** following the established pattern: `[ID]_[Service]_[Purpose]_[Trigger].json`
|
- 💡 **Suggest features** in [Discussions](https://github.com/Zie619/n8n-workflows/discussions)
|
||||||
3. **Add to workflows/** directory (create service folder if needed)
|
- 📝 **Improve documentation**
|
||||||
4. **Remove sensitive data** (credentials, personal URLs)
|
- 🔧 **Submit workflow fixes**
|
||||||
5. **Add tags** for better searchability (calculation, automation, etc.)
|
- ⭐ **Star the repository**
|
||||||
6. **GitHub Actions automatically** updates the public search interface
|
|
||||||
|
|
||||||
### Quality Standards
|
### Development Setup
|
||||||
- ✅ Workflow must be functional and tested
|
|
||||||
- ✅ Remove all credentials and sensitive data
|
|
||||||
- ✅ Follow naming convention for consistency
|
|
||||||
- ✅ Verify compatibility with recent n8n versions
|
|
||||||
- ✅ Include meaningful description or comments
|
|
||||||
- ✅ Add relevant tags for search optimization
|
|
||||||
|
|
||||||
### Custom Node Workflows
|
|
||||||
- ✅ Include npm package links in descriptions
|
|
||||||
- ✅ Document custom node requirements
|
|
||||||
- ✅ Add installation instructions
|
|
||||||
- ✅ Use descriptive tags (like CalcsLive example)
|
|
||||||
|
|
||||||
### Reindexing (for local development)
|
|
||||||
```bash
|
```bash
|
||||||
# Force database reindexing after adding workflows
|
# Fork and clone
|
||||||
python run.py --reindex
|
git clone https://github.com/YOUR_USERNAME/n8n-workflows.git
|
||||||
|
|
||||||
# Or update search index only
|
# Create branch
|
||||||
python scripts/generate_search_index.py
|
git checkout -b feature/amazing-feature
|
||||||
|
|
||||||
|
# Make changes and test
|
||||||
|
python run.py --debug
|
||||||
|
|
||||||
|
# Commit and push
|
||||||
|
git add .
|
||||||
|
git commit -m "feat: add amazing feature"
|
||||||
|
git push origin feature/amazing-feature
|
||||||
|
|
||||||
|
# Open PR
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ⚠️ Important Notes
|
## 🔒 Security
|
||||||
|
|
||||||
### Security & Privacy
|
### Security Features
|
||||||
- **Review before use** - All workflows shared as-is for educational purposes
|
- ✅ **Path traversal protection**
|
||||||
- **Update credentials** - Replace API keys, tokens, and webhooks
|
- ✅ **Input validation & sanitization**
|
||||||
- **Test safely** - Verify in development environment first
|
- ✅ **CORS protection**
|
||||||
- **Check permissions** - Ensure proper access rights for integrations
|
- ✅ **Rate limiting**
|
||||||
|
- ✅ **Docker security hardening**
|
||||||
|
- ✅ **Non-root container user**
|
||||||
|
- ✅ **Regular security scanning**
|
||||||
|
|
||||||
### Compatibility
|
### Reporting Security Issues
|
||||||
- **n8n Version** - Compatible with n8n 1.0+ (most workflows)
|
Please report security vulnerabilities to the maintainers via [Security Advisory](https://github.com/Zie619/n8n-workflows/security/advisories/new).
|
||||||
- **Community Nodes** - Some workflows may require additional node installations
|
|
||||||
- **API Changes** - External services may have updated their APIs since creation
|
|
||||||
- **Dependencies** - Verify required integrations before importing
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📚 Resources & References
|
## 📄 License
|
||||||
|
|
||||||
### Workflow Sources
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||||
This comprehensive collection includes workflows from:
|
|
||||||
- **Official n8n.io** - Documentation and community examples
|
|
||||||
- **GitHub repositories** - Open source community contributions
|
|
||||||
- **Blog posts & tutorials** - Real-world automation patterns
|
|
||||||
- **User submissions** - Tested and verified workflows
|
|
||||||
- **Enterprise use cases** - Business process automations
|
|
||||||
|
|
||||||
### Learn More
|
```
|
||||||
- [n8n Documentation](https://docs.n8n.io/) - Official documentation
|
MIT License
|
||||||
- [n8n Community](https://community.n8n.io/) - Community forum and support
|
|
||||||
- [Workflow Templates](https://n8n.io/workflows/) - Official template library
|
Copyright (c) 2025 Zie619
|
||||||
- [Integration Docs](https://docs.n8n.io/integrations/) - Service-specific guides
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction...
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🏆 Project Achievements
|
## 💖 Support
|
||||||
|
|
||||||
### Repository Transformation
|
If you find this project helpful, please consider:
|
||||||
- **2,053 workflows** professionally organized and named
|
|
||||||
- **365 unique integrations** automatically detected and categorized
|
|
||||||
- **100% meaningful names** (improved from basic filename patterns)
|
|
||||||
- **Zero data loss** during intelligent renaming process
|
|
||||||
- **Advanced search** with 15 service categories
|
|
||||||
|
|
||||||
### Performance Revolution
|
<div align="center">
|
||||||
- **Sub-100ms search** with SQLite FTS5 full-text indexing
|
|
||||||
- **Instant filtering** across 29,445 workflow nodes
|
|
||||||
- **Mobile-optimized** responsive design for all devices
|
|
||||||
- **Real-time statistics** with live database queries
|
|
||||||
- **Professional interface** with modern UX principles
|
|
||||||
|
|
||||||
### System Reliability
|
[](https://www.buymeacoffee.com/zie619)
|
||||||
- **Robust error handling** with graceful degradation
|
[](https://github.com/Zie619/n8n-workflows)
|
||||||
- **Change detection** for efficient database updates
|
[](https://twitter.com/zie619)
|
||||||
- **Background processing** for non-blocking operations
|
|
||||||
- **Comprehensive logging** for debugging and monitoring
|
</div>
|
||||||
- **Production-ready** with proper middleware and security
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This repository represents the most comprehensive and well-organized collection of n8n workflows available, featuring cutting-edge search technology and professional documentation that makes workflow discovery and usage a delightful experience.*
|
## 📊 Stats & Badges
|
||||||
|
|
||||||
**🎯 Perfect for**: Developers, automation engineers, business analysts, and anyone looking to streamline their workflows with proven n8n automations.
|
<div align="center">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[中文](./README_ZH.md)
|
## 🙏 Acknowledgments
|
||||||
|
|
||||||
|
- **n8n** - For creating an amazing automation platform
|
||||||
|
- **Contributors** - Everyone who has helped improve this collection
|
||||||
|
- **Community** - For feedback and support
|
||||||
|
- **You** - For using and supporting this project!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
### ⭐ Star us on GitHub — it motivates us a lot!
|
||||||
|
|
||||||
|
Made with ❤️ by [Zie619](https://github.com/Zie619) and [contributors](https://github.com/Zie619/n8n-workflows/graphs/contributors)
|
||||||
|
|
||||||
|
</div>
|
||||||
Reference in New Issue
Block a user