This Java + Spring Boot starter project fully integrates with dynamic sample content from your ButterCMS account, including main menu, pages, blog posts, categories, and tags, all with a beautiful, custom theme with already-implemented search functionality. All of the included sample content is automatically created in your account dashboard when you sign up for a free trial of ButterCMS.
View our live demo hosted at Heroku, or you can click a button below to deploy your own copy of our starter project to the provider of your choice.
This project requires Java 17 and Maven. All other dependencies (Spring Boot, Java SDK for ButterCMS) are automatically managed by Maven.
To get started, clone and cd into the repo.
git clone https://github.com/ButterCMS/java-starter-buttercms.git
cd java-starter-buttercms
To fetch your ButterCMS content, add your API token as an environment variable.
$ echo 'JAVA_BUTTER_CMS_API_KEY=<Your API Token>' >> .env`Build the project with the following command
$ mvn installTo view the app in the browser, you'll need to run the local development server:
$ mvn spring-boot:runAlternatively, you can run it directly via the java command
$ java -jar target/spring-starter-buttercms-*.jarwhere the file name spring-starter-buttercms will be appended by the value of the version tag <version> in pom.xml
Congratulations! Your starter project is now live. To view your project, point your browser to http://localhost:8080.
Deploy your Spring Boot app using Heroku. With a single click, you'll create a copy of our starter project in your Git provider account, instantly deploy it, and institute a full content workflow connected to your ButterCMS account. Smooth.
By default, your starter project is set up to allow previewing of draft changes
saved in your ButterCMS.com account. To disable this functionality, set the
following value in your .env file: JAVA_BUTTER_CMS_PREVIEW=false