Getting Started on Palmyra

Introduction

Mon, 01 Jan 0001 00:00:00 +0000

Introduction#

Palmyra is a Spring / SpringBoot SDK for publishing REST APIs from annotated POJOs, paired with a React component library that consumes the same APIs.

You write the data model and the business rules. The framework writes the SQL, the URL routing, the JSON serialisation, the paging, the form state, and the grid wiring.

What Palmyra removes from your day#

Hand-rolled controllers — handlers are interfaces; pick the ones you need.
DAO / repository boilerplate — annotations on the model declare the schema; SELECT and INSERT are generated at runtime.
Per-entity client code — one frontend store factory creates per-endpoint stores for grids, forms, lookups, charts, and trees.
Form / grid plumbing on the React side — ready-made PalmyraForm and PalmyraGrid components handle state, validation, paging, sort, and refresh.

What you still own#

Your business logic — handler lifecycle hooks (preCreate, onQueryResult, applyQueryFilter, …) are where it lives.
Your security stack — Spring Security, JWT, OAuth, SSO; Palmyra plugs into them through AuthProvider and the standard Spring PermissionEvaluator.
Your UX — Mantine or MUI, page composition, navigation, themes.

Where to next#

For the framework’s positioning relative to Spring Data REST, JHipster, Hasura, React Admin, and the rest, see Overview. For the rest of this section, continue with Requirements and Installation.

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Installation#

Three things to do: add the dependency, import the configuration class, and confirm it works with a one-class endpoint.

1. Add the dependency#

Gradle#

repositories {
    mavenCentral()
    maven { url "https://repo.palmyralabs.com/releases" }
}

dependencies {
    implementation 'com.palmyralabs.palmyra:palmyra-spring:1.4.4'
}

Maven#

<repositories>
  <repository>
    <id>palmyralabs</id>
    <url>https://repo.palmyralabs.com/releases</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>com.palmyralabs.palmyra</groupId>
    <artifactId>palmyra-spring</artifactId>
    <version>1.4.4</version>
  </dependency>
</dependencies>

2. Import the Palmyra configuration#

@SpringBootApplication
@Import(PalmyraSpringConfiguration.class)
public class App {
    public static void main(String[] args) { SpringApplication.run(App.class, args); }
}

That’s the entire framework hook-up — every Palmyra-annotated handler in the application is now scanned and routed.

Requirements

Mon, 01 Jan 0001 00:00:00 +0000

Requirements#

Java 21 or later
SpringBoot 3.x
Database: MariaDB, MySQL, PostgreSQL, Oracle, or DB2
Build tool: Gradle or Maven
Frontend (optional): Node.js 18+, React 18+, with either MUI or Mantine