Skip to main content

​
Quickstart

Get n8n up and running in minutes and create your first workflow. This guide will help you:
  • Install n8n locally
  • Create your first workflow
  • Understand the n8n interface
  • Test and execute your workflow
This quickstart uses npx for the fastest setup. For production deployments, see the Installation Guide.

​
Step 1: Install and Start n8n

The fastest way to try n8n is with npx (requires Node.js 22.16+): 
npx n8n
Once n8n starts, open your browser to http://localhost:5678. You’ll be prompted to create an owner account.

​
Step 2: Create Your First Workflow

Let’s create a simple workflow that fetches data from an API and processes it.
1

Add a Manual Trigger

  1. Click the + button in the canvas
  2. Search for “Manual Trigger”
  3. Click to add it to your workflow
The Manual Trigger lets you start workflows manually for testing.
2

Add an HTTP Request Node

  1. Click the + button again
  2. Search for “HTTP Request”
  3. Configure it:
    • Method: GET
    • URL: https://jsonplaceholder.typicode.com/users
This will fetch a list of users from a test API.
3

Add a Code Node

  1. Add another node
  2. Search for “Code”
  3. Use this JavaScript to transform the data:
// Transform user data
return items.map(item => ({
  json: {
    name: item.json.name,
    email: item.json.email,
    company: item.json.company.name,
    city: item.json.address.city
  }
}));
4

Test Your Workflow

  1. Click Test workflow button in the top right
  2. Your workflow will execute
  3. Click each node to see the data flowing through

​
Understanding the Interface

The main area where you build workflows by connecting nodes. Click and drag to move nodes, click the connector dots to link them together.

​
Common Workflow Patterns

Schedule + Action

Use a Schedule Trigger to run workflows automatically (e.g., daily reports, data sync)

Webhook + Process

Receive data from external services and process it in real-time

Poll + Notify

Check for new data periodically and send notifications

Manual + Test

Test complex workflows manually before automating them

​
Data Flow

In n8n, data flows from node to node as items. Each item has:
  • json: The main data object
  • binary (optional): File attachments
{
  "json": {
    "name": "John Doe",
    "email": "john@example.com"
  },
  "binary": {}
}
Access data in expressions using $json: 
{{ $json.name }}         // John Doe
{{ $json.email }}        // john@example.com

​
Next Steps

Core Concepts

Learn about nodes, triggers, credentials, and more

Installation

Set up n8n for production use

Building Workflows

Deep dive into workflow creation

AI Workflows

Build AI-powered automations with LangChain

​
Troubleshooting

Check that:
  • Node.js version is 22.16 or higher: node --version
  • Port 5678 is not in use
  • You have permissions to write to the .n8n folder
Common issues:
  • Check that nodes are properly connected
  • Verify API credentials are configured
  • Look for error messages in node output
  • Check browser console for errors
  • Click Test workflow to execute manually
  • Check that previous nodes ran successfully
  • Verify expressions using the Expression Editor
  • Use console.log() in Code nodes for debugging

​
Database Configuration

By default, n8n uses SQLite for storage. For production use, consider PostgreSQL: 
# With environment variables
export DB_TYPE=postgresdb
export DB_POSTGRESDB_HOST=localhost
export DB_POSTGRESDB_PORT=5432
export DB_POSTGRESDB_DATABASE=n8n
export DB_POSTGRESDB_USER=n8n
export DB_POSTGRESDB_PASSWORD=password

npx n8n
See the Installation Guide for complete database configuration.

​
Additional Resources

Join the n8n community forum to connect with other users, share workflows, and get help from the team!