Java starter project

Get up and running with Java and ButterCMS in under two minutes, with a starter that showcases Pages, Collections, and a Blog engine.

One-Click Deploy: Skip local setup and deploy to Vercel instantly.

Quick start

Install dependencies and run setup commands.

git clone https://github.com/ButterCMS/java-starter-buttercms.git
cd java-starter-buttercms

Add your API token as an environment variable and run development server

$ echo 'JAVA_BUTTER_CMS_API_KEY=<Your API Token>' >> .env

Build the project with the following command

$ mvn install -DskipTests

Run the project

$ mvn spring-boot:run

Local Development: http://localhost:8080

GitHub Repository: https://github.com/ButterCMS/java-starter-buttercms

What’s included

Feature	Description
Pages & Page Types	Pre-built page templates with drag-and-drop schema definition
Components	Modular content blocks for dynamic landing pages
Collections	Structured data for navigation, testimonials, FAQs
Blog Engine	Full blog with posts, categories, tags, and search
Media CDN	Automatic image optimization via Filestack

Deploy options

Deploy to Heroku

Deploy to Heroku with environment configuration

Resources

GitHub Repository

View source code and contribute

Spring Guide

Framework integration guide

Additional reading

• Microservices for Startups: An Interview with Steven Czerwinski of Scalyr
• ButterCMS SDKs: A Complete Overview
• How to Overcome the 5 Biggest Node.js Mistakes

Next steps

Core Concepts

Learn about Pages, Collections, and Components

API Reference

Explore the full ButterCMS API