Typesafe Activator

Template template

Template template

schaloner
Source
March 6, 2014
activator template

An Activator template to define an Activator template. It's all very meta.

How to get "Template template" on your computer

There are several ways to get this template.

Option 1: Choose template-template in the Typesafe Activator UI.

Already have Typesafe Activator (get it here)? Launch the UI then search for template-template in the list of templates.

Option 2: Download the template-template project as a zip archive

If you haven't installed Activator, you can get the code by downloading the template bundle for template-template.

  1. Download the Template Bundle for "Template template"
  2. Extract the downloaded zip file to your system
  3. The bundle includes a small bootstrap script that can start Activator. To start Typesafe Activator's UI:

    In your File Explorer, navigate into the directory that the template was extracted to, right-click on the file named "activator.bat", then select "Open", and if prompted with a warning, click to continue:

    Or from a command line:

     C:\Users\typesafe\template-template> activator ui 
    This will start Typesafe Activator and open this template in your browser.

Option 3: Create a template-template project from the command line

If you have Typesafe Activator, use its command line mode to create a new project from this template. Type activator new PROJECTNAME template-template on the command line.

Option 4: View the template source

The creator of this template maintains it at https://github.com/schaloner/activator-template-template#master.

Option 5: Preview the tutorial below

We've included the text of this template's tutorial below, but it may work better if you view it inside Activator on your computer. Activator tutorials are often designed to be interactive.

Preview the tutorial

Typesafe Activator template

You can use this template to create an empty Typesafe Activator template. It can be used with the Activator to generate a template, or cloned. The generated template can then be used as a base for an application template. Further details are available at http://typesafe.com/activator/template/contribute.

What you need to change

There are various placeholder values which need to be replaced. They are detailed below.

project/build.properties

Change the sbt version to the one required by your template

project/plugins.sbt

Add any plugins needed by your template. For example, a Play template would require the Play sbt plugin addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.2.0")"

tutorial/index.html

AKA the file you're currently reading. Provide step-by-step information on how to use and modify the application generated by your template.

activator.properties

This file is used to name and describe your template.

build.sbt

The template build file. Specify the name of your template here, along with the version and any dependencies it has.

LICENSE

Define the license for your template here. If you want to use Markdown, rename this file to LICENSE.md

README.md

Provide general and detailed information on your template.

comments powered by Disqus