Prerequisites
Before you begin, ensure you have Node.js 20 or newer installed on your system.If you don’t have Node.js 20+, see the Installation guide for detailed setup instructions.
Installation
Install dependencies
Install all workspace dependencies using npm:This installs dependencies for all workspaces:
backend, frontend, shared, and mcp-server.Build the shared package
The shared package contains TypeScript types and utilities used across the monorepo:
Start the application
Use the provided startup scripts to launch both backend and frontend servers:The startup script will:
- Install Playwright browsers (Chromium, Firefox, WebKit)
- Start the backend server on port 3003
- Start the frontend server on port 5173
- Display the URLs for accessing the application
The first startup may take a few minutes as Playwright downloads browser binaries.
Access the Application
Once the servers are running, you can access:Frontend UI
Visual workflow builder at
http://localhost:5173Backend API
API server at
http://localhost:3003Swagger Docs
API documentation at
http://localhost:3003/api-docsCreate Your First Workflow
Now that AutoMFlows is running, let’s create a simple browser automation workflow:Open the workflow builder
Navigate to
http://localhost:5173 in your browser. You’ll see the visual workflow editor with a sidebar of available nodes.Add a Start node
The Start node is the entry point for every workflow. It should already be on the canvas. If not, drag it from the Browser category in the sidebar.
Add a Navigate node
- Drag the Navigate node from the Browser category onto the canvas
- Connect the Start node’s output port to the Navigate node’s input port
- Click the Navigate node to configure it in the right sidebar
- Enter a URL, for example:
https://example.com
Add a Screenshot node
- Drag the Screenshot node from the Data category onto the canvas
- Connect the Navigate node’s output to the Screenshot node’s input
- Configure the screenshot settings in the right sidebar (optional)
AutoMFlows uses Playwright for browser automation, supporting Chromium, Firefox, and WebKit.
Available Node Types
AutoMFlows provides 20+ node types organized into categories:Browser
Start, Open Browser, Navigate - Control browser lifecycle and navigation
Interaction
Click, Type - Interact with page elements
Data
Get Text, Screenshot - Extract data from pages
Verification
Verify - Validate browser and API responses
API
API Request, API cURL - Make HTTP requests
Control
Wait, Loop - Control execution flow
Value
Int, String, Boolean, Input Value - Define workflow values
Config
Load Config File, Select Config File - Load configuration data
Code
JavaScript Code - Execute custom JavaScript
Save and Load Workflows
Workflows can be saved and loaded as JSON files:- Click the Save button to export your workflow as JSON
- Click the Load button to import a previously saved workflow
- Share workflow files with team members or use version control
View Results and Reports
After execution, you can:- View node execution results in the results panel
- Check screenshots in the screenshots directory
- Generate reports in multiple formats:
- HTML
- Allure
- JSON
- JUnit XML
- CSV
- Markdown
Next Steps
Installation
Detailed installation guide for all platforms
Node Types
Learn about all available node types and their configurations
Advanced Features
Explore retry strategies, wait options, and plugin system
Plugin Development
Create custom nodes to extend AutoMFlows functionality
Troubleshooting
Port already in use
Port already in use
If ports 3003 or 5173 are already in use, the startup script will attempt to stop existing processes. If this fails, manually kill the processes or change the port in the configuration.
Playwright browsers not installing
Playwright browsers not installing
If Playwright browsers fail to install automatically, manually install them:
Shared package build fails
Shared package build fails
For more help, check the GitHub repository or review server logs for detailed error messages.
