/playframework-core

A boilerplate project for Play! Framework projects. Develop faster with wrapped operations such as CRUD, Repositories, JWT, etc.

Primary LanguageJavaApache License 2.0Apache-2.0

playframework-core

CI Maintainability Test Coverage Version CLA assistant Licence

Core classes & models to re-use on your Play! Framework project.

Dependencies

Check all project dependencies in our AutoPlugin at project/Dependencies.scala file.

How to use?

This project is distributed using GitHub Package Registry using sbt-github-packages plugin, so you need to generate or use your Personal Access Token available on GitHub.

Then, you need to set an Environment Variable OR GitHub Config:

$ export GITHUB_TOKEN=<PERSONAL_ACCESS_TOKEN_AQUI>
$ git config --global github.token <PERSONAL_ACCESS_TOKEN_AQUI>

Now, go to your project and import in your plugins.sbt:

// GitHub Packages plugin.
addSbtPlugin("com.codecommit" % "sbt-github-packages" % "X.Y.Z")

Then, configure your GitHub credentials, Maven resolver and Library Dependencies in build.sbt:

// GitHub Packages config.
// Suppress Warnings about GitHub Repository Owner that is not required (OPTIONAL).
githubSuppressPublicationWarning := true

// Set your Personal Access Token using an Environment Variable or a Git Configuration.
githubTokenSource :=
  TokenSource.Environment("GITHUB_TOKEN") || TokenSource.GitConfig("github.token")

// Add another Maven Resolver using GitHub Package Registry.
resolvers += Resolver.githubPackages("felipebonezi")

// Add the playframework-core dependency.
libraryDependencies += "br.com.felipebonezi" %% "playframework-core" % "vX.Y.Z"

How to run this project?

This project requires Play! Framework v2.8.X and Scala 2.13.X to run.

Install the dependencies and devDependencies and start the server at default port (9000).

$ cd playframework-core
$ sbt compile run

Distribute

Generating pre-built zip archives for distribution:

$ cd playframework-core
$ sbt dist