Quickstart

Get MIFY running locally and execute your first workflow.

Prerequisites

Software	Version	Purpose
Node.js	22+	JavaScript runtime
pnpm	9+	Package manager
PostgreSQL	15+	Database (with pgvector extension)
Git	Any	Version control

Optional:

• Ollama — for local AI models (no API key needed)
• Redis — for caching and rate limiting

Installation

1. Clone and Install

git clone https://github.com/HYGO-INC/mify.git
cd mify
pnpm install

2. Set Up the Database

# Create a PostgreSQL database
createdb mify

# Enable pgvector extension
psql mify -c "CREATE EXTENSION IF NOT EXISTS vector;"

# Run migrations
pnpm --filter @mify/api prisma:migrate dev

3. Configure Environment

Copy the example environment file and set your database URL:

cp .env.example .env

Edit .env:

DATABASE_URL=postgresql://user:password@localhost:5432/mify

4. Start the Platform

# Start the API server (port 3010)
pnpm --filter @mify/api dev

# In a separate terminal, start the web UI (port 3006)
pnpm --filter web dev

5. Open the UI

Navigate to http://localhost:3006 in your browser.

Your First Workflow

1. Open the Canvas

Click Canvas in the navigation to open the visual workflow editor.

2. Add a Trigger

Every workflow starts with a trigger. Drag a Manual Trigger node onto the canvas — this lets you run the workflow by clicking a button.

3. Add an AI Node

Drag a Chat node onto the canvas. This sends a prompt to an AI model and returns the response.

Configure it:

• Provider: Select your AI provider (Ollama for local, or OpenAI/Anthropic with an API key)
• Model: Choose a model (e.g., phi3:mini for Ollama, gpt-4o for OpenAI)
• System Prompt: “You are a helpful assistant.”

4. Connect the Nodes

Click the output handle of the Manual Trigger and drag to the input handle of the Chat node.

5. Run It

Click Run in the toolbar. Enter a message like “What is MIFY?” and see the AI respond.

What’s Next?

• Building Workflows — Learn about node types, branching, and templates
• API Reference — Explore the REST API
• Troubleshooting — Common issues and solutions

Verify Your Setup

Service	URL	Expected
API Server	http://localhost:3010/health	{ "status": "ok" }
Web UI	http://localhost:3006	MIFY interface loads