Getting Started

What is Helix?

Helix Framework is an opinionated framework ecosystem for building professional Spring Boot applications with better consistency, architecture, and developer ergonomics. It combines modular building blocks with conventions that reduce boilerplate so teams can establish a maintainable baseline without replacing Spring Boot workflows.

Clone a Template

The fastest way to evaluate Helix is to create a fresh service from a template, build it locally, and inspect how the generated project uses framework conventions to organize dependencies, build logic, and application structure.

helix init springboot my-example-service

After the first build succeeds, review the generated Gradle structure, starter dependencies, plugin configuration, and any environment-specific conventions that Helix applies by default.

Run the Project

From the generated project directory, start the service with the standard Spring Boot run task. This gives you a fast way to confirm the template builds cleanly, wiring is in place, and the local developer workflow behaves the way your team would expect.

./gradlew bootRun

Once the application starts, review the generated package structure, configuration files, and build setup before moving on to the broader framework concepts.