Scala Project Template
This is a handy starting point for Scala/Java console apps built with SBT.
Projects are built with Scala 2.13, and has been tested with Oracle Java 8, OpenJDK 8 & OpenJDK 11.
Uncomment one line to build with Scala 2.12 instead.
scala_2_11 branch builds projects for Scala 2.11.
This project is licensed with CC0, which puts this project into the public domain.
Please delete the
LICENSE file for any projects you create based on this template project,
unless you want them to be in the public domain as well.
sbtTemplate Bash command
Copy this to a directory on the path (like
/usr/local/bin/), and call it
#!/bin/bash # Clones sbtTemplate and starts a new SBT project # Optional argument specifies name of directory to place the new project into DIR=sbtTemplate if [ "$1" ]; then DIR="$1"; fi git clone https://github.com/mslinn/sbtTemplate.git "$DIR" cd "$DIR" rm -rf .git git init echo "Please edit README.md, build.sbt and publish.sbt right away" echo "After you create the remote repository, type this:" echo "git branch -u origin/master" echo "git add -A" echo "git commit -m "Initial checkin"" echo "git push"
Make the bash script executable:
$ chmod a+x /usr/local/bin/sbtTemplate
To create a new SBT project, run the script.
$ sbtTemplate my-new-project
sbtTemplate sets up the GitHub pages branch for your new project.
Before you can use it, edit
build.sbt and change this line so your GitHub user id and project name are substituted
for the placeholders
git.remoteRepo := "email@example.com:yourGithubId/my-new-project.git"
Now you can publish the Scaladoc for your project with this command:
sbt ";doc ;ghpagesPushSite"
The Scaladoc will be available at a URL of the form:
sbtTemplate you can create a new SBT project and a matching GitHub project with only two commands.
The setup documented below will supply your GitHub username and password,
and will only prompt your for your 2-factor-authentication (2FA) token each time
you run it if you set up your GitHub account to use 2FA.
Install Hub on Mac OS:
$ brew install hub
Install Hub on Linux:
$ sudo -H pip install hub
Put your GitHub login credentials in
hub also executes
export GITHUB_USER=yourGithubUserName export GITHUB_PASSWORD=yourPassword alias git=hub
$ source `~/.bash_profile`
... or reload
$ source `~/.profile`
Using sbtTemplate with Hub
Create a new SBT project and create a new GitHub project, which
hub automatically adds as a
$ sbtTemplate bigBadProject $ git create -d "Project description" two-factor authentication code: 881078 Updating origin created repository: mslinn/bigBadProject
Now check in the new project:
$ git add -A && git commit -m "Initial checkin" && git push -u origin master
Running the Program
bin/run Bash script assembles this project into a fat jar and runs it.
Sample usage, which runs the
Hello entry point in
$ bin/run Hello
-j option forces a rebuild of the fat jar.
Use it after modifying the source code.
$ bin/run -j Hello