Zuvo Docs

Guide

Use Zuvo with Spring Boot

Learn how to create a Spring Boot project and connect it to your Zuvo project.

Prerequisites

Before you begin, make sure you have:

  • Java 17 or later, which you can check with java -version
  • curl and unzip, to download and extract the generated project

1. Create a Zuvo project

To start, you need a Zuvo project.

Create a new Zuvo project from the Dashboard of any organization you belong to.

Save your database password securely. You need it for the connection string.

2. Create a Spring Boot project

Use Spring Initializr to scaffold a new project with the Web, Spring Data JPA, and Postgres Driver dependencies. Run the following from the directory where you keep your projects.

curl https://start.spring.io/starter.zip \
  -d dependencies=web,data-jpa,postgresql \
  -d type=maven-project \
  -d language=java \
  -d groupId=com.example \
  -d artifactId=instruments \
  -d name=instruments \
  -o instruments.zip
unzip instruments.zip -d instruments && cd instruments

3. Set up AI tooling (optional)

Zuvo provides two ways to give AI tools context about your project: Agent Skills, which give your AI coding agent procedural knowledge, and the MCP server, which connects AI assistants to your Zuvo project directly.

Agent Skills

Agent Skills is a curated set of instructions that give your AI agent procedural knowledge about working with Zuvo.

Install them so your AI coding agent can produce more accurate, reliable code using current Zuvo patterns, such as authentication, server-side rendering, and database migrations, rather than relying solely on training data.

Installing Agent Skills

To install, run the following command in the root of your project:

npx skills add supabase/agent-skills

Zuvo MCP server

The Zuvo MCP server connects AI assistants to Zuvo, so they can inspect your schema and act on your projects on your behalf. Find out how to add it to your client in the MCP docs.

4. Set up the Postgres connection details

  1. Navigate to your project dashboard and click on Connect.

  2. Look for the Session pooler connection string and copy it. Replace the password placeholder with your saved database password, and percent-encode any reserved characters it contains, such as &, #, ?, or a space. If you don't have your database password, you can reset it in your Database Settings.

  3. Set sslmode=require either on the connection string itself or as an explicit config option if your framework sets it separately. Most drivers default to prefer, which falls back to sending your data in plaintext if the encrypted attempt fails. You can also enforce SSL on the database side.

The connection strings below show the format only. Take the host, port, and username from the string you copied rather than typing the bracketed placeholders literally.

Select the JDBC tab to copy the connection string in the right format for Spring Boot.

The connection string contains your database password, and application.properties is committed with your project. Set the string as an environment variable instead, and set it the same way on whatever platform you deploy to.

export SUPABASE_DB_URL='jdbc:postgresql://[POOLER-HOST]:5432/postgres?user=postgres.[PROJECT-REF]&password=[YOUR-PASSWORD]&sslmode=require'

Then reference the variable, along with the driver, in src/main/resources/application.properties.

spring.datasource.url=${SUPABASE_DB_URL}
spring.datasource.driver-class-name=org.postgresql.Driver
spring.jpa.hibernate.ddl-auto=update

If the app fails to start with Unable to determine Dialect without JDBC metadata, Hibernate couldn't open a connection at all. Look above that line in the logs for the real cause, most commonly password authentication failed.

5. Change the default schema

By default Hibernate creates tables in the public schema. We recommend changing this as Zuvo exposes the public schema as a data API.

Create the app schema before you start the app. Hibernate creates tables in that schema on startup, but it does not create the schema itself. Run the following in the SQL Editor:

create schema if not exists app;

Then point Hibernate at the schema in application.properties.

spring.jpa.properties.hibernate.default_schema=app

6. Create an entity and repository

Spring Data JPA maps Java classes to database tables. Create an Instrument entity in src/main/java/com/example/instruments/Instrument.java. With spring.jpa.hibernate.ddl-auto=update set, Hibernate creates the instruments table for you when the app starts.

package com.example.instruments;

import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.Table;

@Entity
@Table(name = "instruments")
public class Instrument {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    public Instrument() {}

    public Instrument(String name) {
        this.name = name;
    }

    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

Create an InstrumentRepository interface in the same package. Extending JpaRepository gives you findAll, save, and other query methods without writing any implementation.

package com.example.instruments;

import org.springframework.data.jpa.repository.JpaRepository;

public interface InstrumentRepository extends JpaRepository<Instrument, Long> {}

7. Seed sample data

Add a CommandLineRunner bean to InstrumentsApplication.java that saves some sample instruments the first time the app starts.

package com.example.instruments;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class InstrumentsApplication {

    public static void main(String[] args) {
        SpringApplication.run(InstrumentsApplication.class, args);
    }

    @Bean
    CommandLineRunner seedInstruments(InstrumentRepository instrumentRepository) {
        return args -> {
            if (instrumentRepository.count() == 0) {
                instrumentRepository.save(new Instrument("violin"));
                instrumentRepository.save(new Instrument("viola"));
                instrumentRepository.save(new Instrument("cello"));
            }
        };
    }
}

8. Query data from the app

Create an InstrumentController that fetches every row from the instruments table through the repository and returns it as JSON.

package com.example.instruments;

import java.util.List;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class InstrumentController {

    private final InstrumentRepository instrumentRepository;

    public InstrumentController(InstrumentRepository instrumentRepository) {
        this.instrumentRepository = instrumentRepository;
    }

    @GetMapping("/instruments")
    public List<Instrument> getInstruments() {
        return instrumentRepository.findAll();
    }
}

9. Start the app

Run the Spring Boot app, and go to http://localhost:8080/instruments in your browser. You should see the list of instruments.

./mvnw spring-boot:run

Production requirements

The quickstart procedure in this guide optimizes for getting you to a working app, not for production.

Before you deploy:

  • If your app reads or writes through the Data API, review your Row Level Security policies. Any policy you added here is scoped to this quickstart's sample data, not to real user data.
  • Set your Zuvo credentials as environment variables on whatever platform you deploy to, rather than committing them to source control.
  • Configure a custom domain for your Zuvo project once you're ready to go live.

Next steps