Play Bootstrap

Starting point for Play 2.1 Scala projects

Highlights

• Abnorm: A better non-ORM. A thin, less verbose abstraction layer on top of Anorm
• A data access trait providing Active Record like behavior with minimal effort
• Externalized SQL statements
• Advanced i18n
• Separate configuration environments for production, testing, and development
• Convenience handlers for static resources
• Uncompressed assets for easy debugging in dev; minified and gzipped in production
• jQuery via Google CDN with local fallback
• Bootstrap
• Font Awesome
• Optimized Google Analytics snippet
• The best ideas from HTML5 Boilerplate
• ScalaTest (replaces specs2)

Getting Started

0. Edit the app name and version in project/Build.scala
1. Change the application secret in conf/application.conf
2. Edit the default database name in conf/evolutions/default/0.sql
3. Copy the file conf/local.conf.default to conf/local.conf
4. Set the database configuration parameters in conf/local.conf and conf/local/*.conf
5. Set Google Analytics ID in app/views/layout/base.scala.html
6. Set the site name in conf/i18n/messages.en.conf
7. Replace favicon and Apple touch icons
8. Have fun!

Configuration environments

There are separate configuration environments for production, testing, and development, each represented by a file in conf/local/. conf/application.conf includes conf/local.conf, which in turn includes one of the files in conf/local/. To use the production configuration environment, for instance, just edit local.conf and change the include to conf/local/prod.conf.

conf/local.conf is ignored by Git and thus can be freely edited locally. Sensitive information such as usernames, passwords and API tokens must be put in local.conf to avoid committing them to source control.

Advanced i18n

Localization files in conf/i18n/ are written using the Typesafe Config HOCON format, which fully supports UTF-8 Unicode and is more flexible and powerful than Java .properties.

Messages are rendered by ICU4J. Compared to Java MessageFormat, ICU4J supports named and numbered arguments, enhanced genders and plurals, cardinal (one, two) and ordinal (1st, 2nd, 3rd) numbers, user-friendly apostrophe quoting syntax, and much more. See MessageFormat, PluralFormat, and SelectFormat for reference.

License

Copyright 2013 Marconi Lanna

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.