Before starting, make sure you have JDK 8 installed and configured. See the Lagom documentation if you are not sure whether you have the right version of Java or to find the link for installing it.
We've made it easy to create your first project. The link below uses a Lagom Giter8 template to generate a compressed file that contains:
A distribution of sbt, the Scala build tool. (version 1.2.1, or later, recommended)
A Lagom Hello World project.
Download and extract the project
Download the project .zip file (clicking initiates the download)
Extract the compressed file to a directory of your choice.
Note: On macOS, if you unzip using Archiver, you also have to make the sbt files executable:
chmod u+x ./sbt
chmod u+x ./sbt-dist/bin/sbt
In a shell, change into the top-level directory of the project,
lagom-scala-sbt. For example, if you extracted the project into a directory named
In an OSX or Linux shell:
In a Windows shell:
Start sbt and the Lagom development environment:
It will take a bit of time for the project to build and run. When finished, the console displays the message
Services started, ....
Verify that the services are indeed up and running by invoking the
helloservice endpoint from any HTTP client, such as a browser: http://localhost:9000/api/hello/World
The request returns the message
Congratulations! You've created and run your first Lagom system. See the Lagom documentation to learn more about your new project.