Quick Start

This guide will help you quickly get started with The Pipeline Framework using the visual Canvas designer - the fastest and easiest way to create your first pipeline application!

Prerequisites

Before you begin, ensure you have Java 21+, Maven 3.8+, and an IDE with Quarkus Dev Mode support (like IntelliJ IDEA or VS Code) installed on your system for building and running the generated applications.

Quick Start with Visual Canvas Designer

The fastest way to get started with The Pipeline Framework is by using the visual Canvas designer at https://app.pipelineframework.org.

1. Access the Canvas Designer

Visit https://app.pipelineframework.org in your web browser.

2. Create Your First Pipeline

1. Click the "New Pipeline" button
2. Start adding steps by clicking the "+" button
3. Configure each step by:
   • Setting a descriptive name
   • Choosing the appropriate cardinality (1-1, Expansion, Reduction, or Side effect)
   • Defining input and output fields with rich Java types

3. Download Your Complete Application

Once you've designed your pipeline:

1. Click the "Download Application" button
2. Save the generated ZIP file containing your complete application

4. Build and Run Your Application

Extract the ZIP file and navigate to the application directory:

unzip your-pipeline-app.zip
cd your-pipeline-app
./mvnw clean compile
./mvnw quarkus:dev

Your application is now running locally.

Next Steps

Congratulations! You've successfully created your first pipeline application. Now explore these topics:

• Canvas Designer Guide - Complete guide to using the visual designer
• Application Structure - Learn how the generated application is structured
• Functional Architecture - Deep dive into the framework architecture

Template Generator (Reference Only)

The visual Canvas is the primary way to create new applications. If you need automation or CI-only generation, use the template generator as a secondary option.

See Template Generator Guide for details.