Skip to main content

​
Build and Run Locally

Once you have set up your local developer environment, you can build and run a connector locally.

​
Prerequisites

Before you start, complete the following tasks:
  • Set up your local developer environment
  • Install Maven and Java (JDK 17 or later)
  • Clone the connector template repository

​
Build the Connector Template

To build the Grand Central connector template, run the following commands: 
git clone [email protected]:bb-ecos-core/grandcentral-connector-template.git
cd grandcentral-connector-template
mvn clean package
These commands generate the following artifacts:
  • A ready-to-use Quarkus application with Camel routes in the target/quarkus-app directory
  • An OpenAPI specification that is implemented by the connector in the target/generated-resources directory

​
Run a Connector Locally

You have several options to run a connector locally:

​
Option 1: Run as JAR

Run the connector as a JAR directly: 
java -jar target/quarkus-app/quarkus-run.jar
This runs a Quarkus application with the production profile applied.

​
Option 2: Run with Quarkus Maven Plugin

Run as a Quarkus application with the Quarkus Maven plugin: 
mvn quarkus:dev
This command runs an application in Quarkus development mode, where:
  • The application API is accessible at http://localhost:8080/
  • The Quarkus service routes are accessible at http://localhost:8080/q/
  • The Quarkus Dev UI is accessible at http://localhost:8080/q/dev-ui

​
Option 3: Run and Debug in IntelliJ IDEA

Run and debug as a regular Quarkus application (similar to a Spring Boot application) from IntelliJ IDEA:
1

Enable Quarkus Plugin

Enable the JetBrains Quarkus plugin
2

Create Run/Debug Configuration

Create a Run/Debug configuration in IntelliJ IDEA
3

Run in Debug Mode

All debug functionality is available, which means you can run the connector in debug mode and dive into routes and check local variables values

​
Accessing the Running Connector

Once your connector is running locally, you can access:
  • API Endpoints: http://localhost:8080/
  • Health Checks: http://localhost:8080/q/health
  • Metrics: http://localhost:8080/q/metrics
  • Dev UI (dev mode only): http://localhost:8080/q/dev-ui

​
Next Steps