> ## Documentation Index
> Fetch the complete documentation index at: https://buttercms.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<Info>
  **One-Click Deploy**: Skip local setup and [deploy to Vercel instantly](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FButterCMS%2Fjava-starter-buttercms\&env=BUTTER_CMS_API_KEY\&envDescription=Your%20ButterCMS%20API%20Token\&envLink=https%3A%2F%2Fbuttercms.com%2Fsettings%2F).
</Info>

## Quick start

Install dependencies and run setup commands.

```bash theme={null}
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

```bash theme={null}
$ echo 'JAVA_BUTTER_CMS_API_KEY=<Your API Token>' >> .env
```

Build the project with the following command

```bash theme={null}
$ mvn install -DskipTests
```

Run the project

```bash theme={null}
$ mvn spring-boot:run
```

**Local Development**: [http://localhost:8080](http://localhost:8080)

**GitHub Repository**: [https://github.com/ButterCMS/java-starter-buttercms](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

<CardGroup cols={1}>
  <Card title="Deploy to Heroku" icon="cloud" href="https://heroku.com/deploy?template=https://github.com/ButterCMS/java-starter-buttercms">
    Deploy to Heroku with environment configuration
  </Card>
</CardGroup>

## Resources

<CardGroup cols={2}>
  <Card title="GitHub Repository" icon="github" href="https://github.com/ButterCMS/java-starter-buttercms">
    View source code and contribute
  </Card>

  <Card title="Spring Guide" icon="book" href="../../frameworks/non-javascript-frameworks/spring">
    Framework integration guide
  </Card>
</CardGroup>

## Additional reading

* [Microservices for Startups: An Interview with Steven Czerwinski of Scalyr](https://buttercms.com/blog/microservices-for-startups-an-interview-with-steven-czerwinski-of-scalyr/)
* [ButterCMS SDKs: A Complete Overview](https://buttercms.com/blog/buttercms-sdks-complete-overview/)
* [How to Overcome the 5 Biggest Node.js Mistakes](https://buttercms.com/blog/how-to-overcome-the-5-biggest-nodejs-mistakes/)

## Next steps

<CardGroup cols={2}>
  <Card title="Core Concepts" icon="book" href="../../core-concepts/content-types/pages">
    Learn about Pages, Collections, and Components
  </Card>

  <Card title="API Reference" icon="code" href="../../api">
    Explore the full ButterCMS API
  </Card>
</CardGroup>