-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: 🚨 rename project to PlayGround
Signed-off-by: Felipe Bonezi <[email protected]>
- Loading branch information
1 parent
fc6d845
commit 7465b60
Showing
7 changed files
with
17 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,83 +1,15 @@ | ||
# playframework-core | ||
# play-ground | ||
|
||
[![CI](https://github.com/felipebonezi/playframework-core/actions/workflows/continouos-integration.yml/badge.svg)](https://github.com/felipebonezi/playframework-core/actions/workflows/continouos-integration.yml) | ||
[![Maintainability](https://api.codeclimate.com/v1/badges/56ea88cd8146afd188c0/maintainability)](https://codeclimate.com/github/felipebonezi/playframework-core/maintainability) | ||
[![Test Coverage](https://api.codeclimate.com/v1/badges/56ea88cd8146afd188c0/test_coverage)](https://codeclimate.com/github/felipebonezi/playframework-core/test_coverage) | ||
[![Version](https://img.shields.io/github/v/release/felipebonezi/playframework-core?logo=java)](https://github.com/felipebonezi/playframework-core/releases) | ||
[![CLA assistant](https://cla-assistant.io/readme/badge/felipebonezi/playframework-core)](https://cla-assistant.io/felipebonezi/playframework-core) | ||
[![Licence](https://img.shields.io/github/license/felipebonezi/playframework-core?color=blue)](https://github.com/felipebonezi/playframework-core/blob/main/LICENSE) | ||
[![CI](https://github.com/felipebonezi/play-ground/actions/workflows/continouos-integration.yml/badge.svg)](https://github.com/felipebonezi/play-ground/actions/workflows/continouos-integration.yml) | ||
[![Maintainability](https://api.codeclimate.com/v1/badges/56ea88cd8146afd188c0/maintainability)](https://codeclimate.com/github/felipebonezi/play-ground/maintainability) | ||
[![Version](https://img.shields.io/github/v/release/felipebonezi/play-ground?logo=java)](https://github.com/felipebonezi/play-ground/releases) | ||
[![CLA assistant](https://cla-assistant.io/readme/badge/felipebonezi/play-ground)](https://cla-assistant.io/felipebonezi/play-ground) | ||
[![Licence](https://img.shields.io/github/license/felipebonezi/play-ground?color=blue)](https://github.com/felipebonezi/play-ground/blob/main/LICENSE) | ||
|
||
Core classes & models to re-use on your [Play! Framework](https://playframework.com/) project. | ||
|
||
### Dependencies | ||
|
||
- [jBCrypt](https://www.mindrot.org/projects/jBCrypt/) | ||
- [Java JWT](https://github.com/auth0/java-jwt) | ||
|
||
Check all project dependencies in our AutoPlugin | ||
at [project/Dependencies.scala](https://github.com/felipebonezi/playframework-core/blob/main/project/Dependencies.scala) | ||
file. | ||
|
||
### How to use? | ||
|
||
This project is distributed using GitHub Package Registry | ||
using [sbt-github-packages](https://dev.to/gjuoun/publish-your-scala-library-to-github-packages-4p80) plugin, so you | ||
need to generate or use | ||
your [Personal Access Token](https://docs.github.com/pt/github/authenticating-to-github/creating-a-personal-access-token) | ||
available on GitHub. | ||
|
||
Then, you need to set an Environment Variable **OR** GitHub Config: | ||
|
||
```sh | ||
$ export GITHUB_TOKEN=<PERSONAL_ACCESS_TOKEN_AQUI> | ||
``` | ||
|
||
```sh | ||
$ git config --global github.token <PERSONAL_ACCESS_TOKEN_AQUI> | ||
``` | ||
|
||
Now, go to your project and import in your `plugins.sbt`: | ||
|
||
```scala | ||
// 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`: | ||
|
||
```scala | ||
// 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](https://playframework.com/) v2.8.X and [Scala](https://www.scala-lang.org) | ||
2.13.X to run. | ||
|
||
Install the dependencies and devDependencies and start the server at default port (9000). | ||
|
||
```sh | ||
$ cd playframework-core | ||
$ sbt compile run | ||
``` | ||
|
||
#### Distribute | ||
|
||
Generating pre-built zip archives for distribution: | ||
|
||
```sh | ||
$ cd playframework-core | ||
$ sbt dist | ||
libraryDependencies += "io.github.felipebonezi" %% "play-ground" % "X.Y.Z" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,7 +11,7 @@ object Common extends AutoPlugin { | |
|
||
override def requires: Plugins = JvmPlugin && HeaderPlugin | ||
|
||
val repoName = "playframework-core" | ||
val repoName = "play-ground" | ||
|
||
override def globalSettings: Seq[Setting[_]] = | ||
Seq( | ||
|
@@ -32,12 +32,6 @@ object Common extends AutoPlugin { | |
), | ||
// on the web | ||
homepage := Some(url(s"https://github.com/felipebonezi/$repoName")), | ||
scmInfo := Some( | ||
ScmInfo( | ||
url(s"https://github.com/felipebonezi/$repoName"), | ||
s"scm:git:[email protected]:felipebonezi/$repoName.git" | ||
) | ||
), | ||
developers += Developer( | ||
"contributors", | ||
"Contributors", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters