Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 2.65 KB

Installing.md

File metadata and controls

43 lines (25 loc) · 2.65 KB
Raw

Installing Play

This page shows how to download, install and run a Play application. There's a built in tutorial that shows you around, so running this Play application will show you how Play itself works!

Play is a series of libraries available in Maven Repository, so you can use any Java build tool to build a Play project. However, much of the development experience Play is known for (routes, templates compilation and auto-reloading) is provided by sbt. In this guide we describe how to install Play with sbt.

Prerequisites

Play requires at least Java 17, however also supports Java 21. To check that you have the latest JDK, please run:

java -version

You should see something like:

openjdk version "17.0.8" 2023-07-18
OpenJDK Runtime Environment Temurin-17.0.8+7 (build 17.0.8+7)
OpenJDK 64-Bit Server VM Temurin-17.0.8+7 (build 17.0.8+7, mixed mode)

If you don't have the JDK, you have to install it from Adoptium.

Installing Play with sbt

We provide a number of sample projects that have ./sbt and sbt.bat launchers for Unix and Windows environments respectively. These can be found on our download page. The launcher will automatically download dependencies without you having to install sbt ahead of time.

Or, refer to the sbt download page to install the sbt launcher on your system, which provides the sbt command.

Note: See sbt documentation for details about how to configure sbt. We recommend that you use the latest version of sbt.

If your proxy requires user/password for authentication, you need to add system properties when invoking sbt instead: ./sbt -Dhttp.proxyHost=myproxy -Dhttp.proxyPort=8080 -Dhttp.proxyUser=username -Dhttp.proxyPassword=mypassword -Dhttps.proxyHost=myproxy -Dhttps.proxyPort=8080 -Dhttps.proxyUser=username -Dhttps.proxyPassword=mypassword

Running Play with sbt

sbt provides all the necessary commands to run your application. For example, you can use sbt run to run your app. For more details on running Play from the command line, refer to the [[new application documentation|NewApplication]].

Congratulations!

You are now ready to work with Play! The next page will show you how to create projects from the command line and some more detail about creating new applications.