Core Search Play Seed

This template generates a skeleton Play Framework application with most of the dependencies and configurations that Core Search typically needs.

Prerequisites

You must install Giter8 and SBT to use this template.

brew install giter8
brew install sbt

Running

If you want to create a project

sbt new cbdr/core-search-play-seed.g8

You will be prompted to enter some variables

name [core-search-play-seed]:
scala_version [2.11.11]:
scalatestplusplay_version [2.0.0]: 
play_version [2.5.14]:

If you do not enter your own values, the defaults in the brackets will be used (you should definitely override the name).

For even faster project generation

sbt new cbdr/core-search-play-seed.g8 --name=my-awesome-play-app

This will forgo the prompts and create your Play app with the name my-awesome-play-app with the default values for the other parameters.

Recommended Usage

This template is designed for basic project setup. Your Play Framework application probably does not require every library and configuration included in this repo. In fact, it is highly unlikely. During your productionization process (or earlier), be sure to remove all unneeded dependencies and configurations. Remember that includes the configurations made in your production.conf stored in S3.

What's Included

ScalaTest
Mockito
Akka TestKit (Akka is automatically included with Play)
Play Slick
Slick Extensions
MySQL Driver
AWS SDK

Database Configurations

The following tables are configured for Aurora and MS SQL in US Staging, United States, and the European Union.

SearchData
SearchRefeed
SearchFeed
SearchTrans

Reference the configuration file for specific naming of each connection.

Configuration

The production config file can be found in S3: framework-secrets/play-seed

Note: This file should be used as a template and not as the actual production config file for your application.

Deployment

Nimbus

There is a Nimbus template for a typical Play Framework application and an example Nimbus settings file that you can reference.

Chef

There is an example Chef cookbook that is referenced in the Nimbus file. It should get you most of the way to deployment, but you should make your own and use this as just a reference.

pgordon9 / core-search-play-seed.g8