Quick Start Guide

Get Loopstack running locally in a few minutes.

Prerequisites

Node.js 18.0+
Docker
NestJS CLI (npm install -g @nestjs/cli)

1. Create Your App

Scaffold a standard NestJS project and install the Loopstack module:


nest new my-app
cd my-app
npm install @loopstack/loopstack-module

2. Start Infrastructure

Full (with Studio)

Start the Docker environment including PostgreSQL, Redis, and Loopstack Studio:


docker compose -f node_modules/@loopstack/loopstack-module/docker-compose.yml up -d

Studio will be available at http://localhost:5173 .

3. Configure

Add LoopstackModule to the imports in src/app.module.ts:


import { Module } from '@nestjs/common';
import { LoopstackModule } from '@loopstack/loopstack-module';
 
@Module({
  imports: [LoopstackModule.forRoot()],
})
export class AppModule {}

Add YAML asset bundling to nest-cli.json so workflow UI configs are included in the build:


{
  "compilerOptions": {
    "assets": ["**/*.yaml"]
  }
}

4. Run


npm run start:dev

Your backend is now running at http://localhost:3000 and Studio is available at http://localhost:5173 .

5. Verify Your Setup

Follow the Hello World Workflow guide to create a simple, first workflow.

What’s Next

Core Concepts — Understand the building blocks
Your First Workflow — Build a real workflow with AI