Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.49 KB

README.md

File metadata and controls

56 lines (37 loc) · 1.49 KB
Raw

This is a Giter8 template for Freestyle projects.

Creating New Freestyle Project

  1. Create a new project from Freestyle g8 template:
sbt new frees-io/freestyle-template.g8
  1. Fill the required information (you can see an example below):
...

name [Project Name]: freestyle-rpc
projectDescription [Project Description]: RPC with Freestyle
project [project-name]: freestyle-rpc
package [freestyle]:
Skipping existing file: ./freestyle-rpc/.gitignore
Skipping existing file: ./freestyle-rpc/.scalafmt.conf

Template applied in ./freestyle-rpc

The new project will be created in a new folder in the root directoy of this project with the name introduced before. It will contain the basic structure and basic sbt configuration based on the sbt-freestyle and sbt-org-policies plugins.

  1. Create the organization files, to do so, from the project folder, you could just run:
sbt orgCreateFiles
  1. Verify that everything is correctly configured:
sbt orgScriptCI

Debugging this template

In the case you need to change this plugin, the easiest way to test it locally is:

sbt new file:///the/path/to/freestyle-template.g8

Template license

Written in 2017 by 47 Degrees

To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this template to the public domain worldwide. This template is distributed without any warranty. See http://creativecommons.org/publicdomain/zero/1.0/.