Spring Initializr

Prerequisites

You need Java (1.6 or better) and a bash-like shell.

If you are on a Mac and using homebrew, all you need to do to install it is:

$ brew install spring-boot-cli

It will install /usr/local/bin/spring. You can jump right to running the app.

An alternative way to install the spring command line interface can be installed like this:

$ curl start.spring.io/install.sh | bash

After running that command you should see a spring directory:

$ ./spring/bin/spring --help

usage: spring [--help] [--version]
   <command> [<args>]
...

You could add that bin directory to your PATH (the examples below assume you did that).

If you don't have curl or zip you can probably get them (for Windows users we recommend cygwin), or you can download the zip file and unpack it yourself.

Running the app locally

Use the spring command:

$ spring run app.groovy

Deploying to Cloud Foundry

If you are on a Mac and using homebrew, install the Cloud Foundry CLI:

$ brew install cloudfoundry-cli

Alternatively, download a suitable binary for your platform from Pivotal Web Services.

To help avoid a timeout on startup you should upload all the dependencies. You can get those locally by running spring grab:

$ spring jar app.groovy

this will create a local directory repository/ with all the jar dependencies. Then when you cf push they will be uploaded and used.

An example Cloud Foundry manifest.yml file is provided. You should ensure that the application name and URL (name and host values) are suitable for your environment before running cf push.

Alternatively you can jar up the app and make it executable in any environment. Care is needed with the includes and excludes:

$ spring jar --include '+spring.zip' start.jar app.groovy
$ cf push start -p start.jar -n start-<space>

Where <space> is the name of the space. As a failsafe, and a reminder to be explicit, the deployment will fail in production without the -n. It is needed to select the route because there is a manifest that defaults it to start-development.

If you are deploying the "legacy" service for STS in production:

$ cf push start-legacy -p start.jar -n start-legacy