Documentation

§Creating a new application

§Using Play Starter Projects

If you’ve never used Play before, then you can download a starter project. The starter projects have lots of comments explaining how everything works and have links to documentation that goes more in depth.

If you download and unzip one of the .zip files at the starter projects, you’ll see the sbt file – this is a packaged version of sbt, the build tool that Play uses.

See our download page to get more details about how to use the starter projects.

§Create a new application using SBT

If you have sbt 0.13.13 or higher installed, you can create your own Play project using sbt new using a minimal giter8 template (roughly like a maven archetype). This is a good choice if you already know Play and want to create a new project immediately.

Note that the seed templates are already configured with CSRF and security headers filters, whereas the other projects are not specifically set up for security out of the box.

§Play Java Seed

sbt new playframework/play-java-seed.g8

§Play Scala Seed

sbt new playframework/play-scala-seed.g8

After that, use sbt run and then go to http://localhost:9000 to see the running server.

Type g8Scaffold form from sbt to create the scaffold controller, template and tests needed to process a form. You can also create your own giter8 seeds and scaffolds based off this one by forking from the https://github.com/playframework/play-java-seed.g8 or https://github.com/playframework/play-scala-seed.g8 github projects.

§Play Example Projects

Play has many features, so rather than pack them all into one project, we’ve organized many example projects that showcase a feature or use case of Play so that you can see Play at work.

Note: the example projects are not configured for out of the box security, and are intended to showcase particular areas of Play functionality.

See our download page to get more details about how to use the download and use the example projects.

Next: Using the Play console


Found an error in this documentation? The source code for this page can be found here. After reading the documentation guidelines, please feel free to contribute a pull request.