If you have the prerequisites installed and are familiar with Maven, create a Hello World project using the procedures on this page. Otherwise, see detailed instructions for help to set up the prerequisites and get started. Prerequisites for using Lagom with Maven include:
- JDK 8
- Maven 3.6 or higher
We've made it easy to create your first project. The link below invokes the Maven mvn archetype:generate
command to create a Lagom Hello World project and compresses it in a zip file.
Download and Extract the project
Download the project .zip file (clicking initiates the download).
Extract the compressed file to a directory of your choice.
In a shell, change into the top-level directory of the project,
lagom-java-maven
. For example, if you extracted the project into a directory namedmy-project
:- In a macOS or Linux shell:
cd my-project/lagom-java-maven
- In a Windows shell:
cd my-project\lagom-java-maven
- In a macOS or Linux shell:
Start Maven and the Lagom development environment:
mvn lagom:runAll
It will take a bit of time to build and run the project. When finished, the console displays the message:
Services started, ...
.Verify that the services are indeed up and running by invoking the
hello
service endpoint from any HTTP client, such as a browser: http://localhost:9000/api/hello/WorldThe request returns the message
Hello, World!
.
Congratulations! You've created and run your first Lagom system. See the documentation to understand your new project.
You might find the Hello World template useful when starting a new project of your own. If you prefer to customize it more, see the manual instructions for generating a project from the Lagom Maven archetype.