Dependencies

Dependency libraries

Xitrum includes some libraries. In your Xitrum project, you can use them directly if you want.

Main dependencies:

• Scala: Xitrum is written in Scala language.
• Netty: For async HTTP(S) server. Many features in Xitrum are based on those in Netty, like WebSocket and zero copy file serving.
• Akka: For SockJS. Akka depends on Typesafe Config, which is also used by Xitrum.

Other dependencies:

• Commons Lang: For escaping JSON data.
• Glokka: For clustering SockJS actors.
• JSON4S: For parsing and generating JSON data. JSON4S depends on Paranamer.
• Rhino: For Scalate to compile CoffeeScript to JavaScript.
• Sclasner: For scanning HTTP routes in action classes in .class and .jar files.
• Scaposer: For i18n.
• Twitter Chill: For serializing and deserializing cookies and sessions. Chill is based on Kryo.
• SLF4S, Logback: For logging.

Xitrum new project skeleton includes these tools:

• scala-xgettext: For extracting i18n strings from your .scala files when you compile them.
• xitrum-package: For packaging your project, ready to deploy to production server.
• Scalive: For connecting a Scala console to a running JVM process for live debugging.

Related projects

Demos:

• xitrum-new: Xitrum new project skeleton.
• xitrum-demos: Demos features in Xitrum.
• xitrum-placeholder: Demos APIs that return images.
• comy: Demos a simple URL shortening service.
• xitrum-multimodule-demo: Example about creating multimodule SBT project.

Plugins:

• xitrum-scalate: This is the default template engine in Xitrum, preconfigured in Xitrum new project skeleton. You can replace it with other template engines, or totally remove it if your project doesn’t need any template engine. It depends on Scalate and Scalamd.
• xitrum-hazelcast: For clustering cache and server side sessions.
• xitrum-ko: Provides some convenient helpers for Knockoutjs.

Other projects:

• xitrum-doc: Source code of the Xitrum Guide.
• xitrum-hp: Source code of the Xitrum Homepage.