Getting Started

This guide helps you get Loopi running locally and create your first automation.

Prerequisites

Before you begin, make sure you have:

• Node.js (>= 18 recommended)
• npm or pnpm package manager
• Git for cloning the repository

Quick Start

1. Clone the Repository

git clone https://github.com/Dyan-Dev/loopi.git
cd loopi

2. Install Dependencies

Using pnpm (recommended):

pnpm install

Or using npm:

npm install

3. Start Development Mode

pnpm start

This will:

• Start the Electron application in development mode
• Enable hot reload for faster development
• Open the Loopi UI automatically

Creating Your First Automation

Once the app is running, you'll see the main dashboard.

Step 1: Create a New Workflow

1. Click the "Add Automation" button in the dashboard
2. You'll be redirected to the workflow builder console
3. Navigate to Settings to name your automation

Step 2: Add Steps

Click the Navigate node (added by default) to configure it:

1. In the properties panel, set the URL to your target website
2. Select next step by selecting the step in add next step panel
3. Choose from available node types.

Navigate to a website:

• Type: Navigate
• URL: https://example.com

Extract text:

• Type: Extract
• Selector: h1
• Store as: pageTitle

Take a screenshot:

• Type: Screenshot
• Save path: example.png (optional)

Step 3: Run the Automation

1. Click the "Run" button
2. Watch the automation execute in a browser window

Next Steps

Now that you have Loopi running:

• Learn more: Read the Usage Guide to understand all features
• Try examples: Check out Examples for ready-made automations
• Explore API: See the API Reference for advanced usage
• Build & package: Visit Installation for packaging instructions

Troubleshooting

App won't start

• Make sure all dependencies are installed: pnpm install
• Check Node.js version: node --version (should be >= 18)

Browser window doesn't open

• Check console for errors
• Try closing and restarting the app

Need more help?

• Check the FAQ
• Visit GitHub Discussions
• Report issues on GitHub