Assumptions:
This Cheat Sheet assumes that
a) you have a basic understanding of java platform, maven build tool and IntelliJ IDEA.
b) you use windows platform for development
c) you use IntelliJ IDEA v9, java v1.6+, maven v2.2.1, git v1.7.1.1, scala v2.7.7, lift v2.0 and simple build tool v0.7.4
Install Java, maven, Git, IntelliJ IDEA and simple build tool and configure the PATH environment variable accordingly for all three:
Option 1:
Clone this repository with:
git clone git://github.com/dpp/lift_sbt_prototype.git
Then cd into lift_sbt_prototype and type:
sbt
At the sbt prompt, type:
update
Then:
jetty-run
Point your browser to:
http://localhost:8080/
Voila a running Lift app
Option 2:
1. Download simple-build-tool jar file from its official source:
http://code.google.com/p/simple-build-tool/
2. Create a script sbt.bat to launch sbt:
set SCRIPT_DIR=%~dp0
java -Xmx512M -jar “%SCRIPT_DIR%sbt-launch.jar” %*
if proxy is enabled then use:
java -Dhttp.proxyHost=myproxy -Dhttp.proxyPort=8080 -Dhttp.proxyUser=username -Dhttp.proxyPassword=mypassword -Xmx512M -jar “%SCRIPT_DIR%sbt-launch.jar” %*
To avoid frequent OutOfMemory errors, try modifying your sbt launch bat script to the following:
java -XX:+CMSClassUnloadingEnabled -XX:MaxPermSize=256m -Xmx512M -Xss2M -jar “%SCRIPT_DIR%sbt-launch.jar” %*
Note: Keep sbt-launch.jar and sbt.bat in a separate directory and not within scala installation directory.
3. First create the basic structure of Lift project using maven in windows:
mvn archetype:generate -U ^
-DarchetypeGroupId=net.liftweb ^
-DarchetypeArtifactId=lift-archetype-basic ^
-DarchetypeVersion=2.0 ^
-DarchetypeRepository=http://scala-tools.org/repo-snapshots ^
-DremoteRepositories=http://scala-tools.org/repo-snapshots ^
-DgroupId=com.myProject1 -DartifactId=myProject1
Note: -DarchetypeArtifactId can have one of the three values
– lift-archetype-blank
– lift-archetype-basic
– lift-archetype-jpa-basic
4. Then cd into myProject1 and run:
sbt
5. At the sbt prompt, type:
Project does not exist, create new project? (y/N/s) y
Name: myProject1
Organization: com.myProject1
Version [1.0]:
Scala version [2.7.7]:
sbt version [0.7.4]:
Note: Basically, you enter ‘y’ for yes or ‘s’ for starting a project from scratch (in our case we have already generated our project using maven)
6. Setup the project configuration. Your project configurations are defined at myProject1/project/build/myProject1Project.scala.
Create the directory:
project/build
7. Then create the /project/build/myProject1Project.scala file with the following:
import sbt._
class myProject1Project(info: ProjectInfo) extends DefaultWebProject(info)
{
val snapshots = ScalaToolsSnapshots
val lift = “net.liftweb” % “lift-mapper” % “2.0” % “compile”
val jetty6 = “org.mortbay.jetty” % “jetty” % “6.1.22” % “test”
val h2 = “com.h2database” % “h2” % “1.2.134”
val servlet = “javax.servlet” % “servlet-api” % “2.5” % “provided”
val derby = “org.apache.derby” % “derby” % “10.2.2.0” % “runtime”
val junit = “junit” % “junit” % “4.7” % “test”
// required because Ivy doesn’t pull repositories from poms
val smackRepo = “m2-repository-smack” at “http://maven.reucon.com/public”
val nexusRepo = “nexus” at “https://nexus.griddynamics.net/nexus/content/groups/public”
}
For ~jetty, you will still have to hit return at the sbt prompt to restart jetty in order to see changes. To avoid this use:
override def jettyWebappPath = webappPath
If you’re running with Jrebel (see near the end of the post), avoid unnecessary redeploys with:
override def scanDirectories = Nil
8. Then on the sbt prompt, run:
reload
9. Next on the sbt prompt, run:
update
10. Then on the sbt prompt, run:
~jetty-run
11. Point your browser to:
http://localhost:8080/
Note: Your app is running and accessible at this point
12. To use with IntelliJ IDEA,
a) install the scala and sbt plugin.
b) In Setting => Plugins give the path of sbt-launch.jar file.
c) Go to the “Before launch” options of a Run Configuration, uncheck “Make” and choose “Run SBT Action / test-compile”
d) Create a new IntelliJ IDEA project using Import Project from External Model => Maven
e) Add a Scala aspect to the project, employing Use Files. In Project Structure => Facets => Scala; point the plug-in to the myProject1/project/boot subdirectory where sbt downloaded your Scala
For further improvement in development life cycle:
a) Put libraries in myProject1/lib and sources in myProject1/src
b) On sbt prompt,
package
action will create a WAR file for when you are ready to deploy your webapp on a production server.
c) JRebel (formerly known as JavaRebel) is a plugin for the Java Virtual Machine that enables on-the-fly reloading of changes made to Java class files.
ZeroTurnaround provide a free JRebel license for developers using Scala.
Download and install JRebel from
http://www.zeroturnaround.com/jrebel/
In order to integrate JRebel into your build, first turn off automatic reloading in jetty in maven pom.xml by setting the scanIntervalSeconds value to 0:
<plugin>
<groupId>org.mortbay.jetty</groupId>
<artifactId>maven-jetty-plugin</artifactId>
<version>6.1.22</version>
<configuration>
<contextPath>/</contextPath>
<scanIntervalSeconds>0</scanIntervalSeconds>
</configuration>
</plugin>
Then add the following to your MAVEN_OPTS environment variable:
-noverify -javaagent:/path/to/jrebel/jrebel.jar
Following pages were accessed to consolidate this post:
http://www.assembla.com/wiki/show/liftweb/Getting_Started
http://www.assembla.com/wiki/show/liftweb/Using_Maven
http://www.assembla.com/wiki/show/liftweb/Using_SBT
http://code.google.com/p/simple-build-tool/wiki/Setup
http://code.google.com/p/simple-build-tool/wiki/RunningSbt
http://www.assembla.com/wiki/show/liftweb/Using_IntelliJ_IDEA_to_develop_Lift_applications
http://plugins.intellij.net/plugin/?idea&id=5007
Updates for Scala 2.8 will come soon. Feel free to leave your comments 🙂
disturbance under still waters 