Skip to main content
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

FeatureDescription
Pages & Page TypesPre-built page templates with drag-and-drop schema definition
ComponentsModular content blocks for dynamic landing pages
CollectionsStructured data for navigation, testimonials, FAQs
Blog EngineFull blog with posts, categories, tags, and search
Media CDNAutomatic 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

Next steps

Core Concepts

Learn about Pages, Collections, and Components

API Reference

Explore the full ButterCMS API