Async and clustered Scala web framework and HTTP(S) server on top of Netty and Hazelcast
Switch branches/tags
Nothing to show
Pull request Compare This branch is 1402 commits behind xitrum-framework:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
plugin
sbt
src/main
.gitignore
AUTHORS
CHANGELOG
DEV
MIT-LICENSE
README.rst
build.sbt

README.rst

http://www.bdoubliees.com/journalspirou/sfigures6/schtroumpfs/s3.jpg

Xitrum (means "Smurf" in Vietnamese) is an async and clustered Scala web framework and HTTP(S) server on top of Netty and Hazelcast:

  • It tries to fill the spectrum between Scalatra and Lift: more powerful than Scalatra and easier to use than Lift. You can easily create both RESTful APIs and postbacks. Xitrum is controller-first like Scalatra, not view-first like Lift.
  • Routes are automatically collected in the spirit of JAX-RS (but without annotations!) and Rails Engines. You don't have to declare all routes in a single place. Think of this feature as distributed routes. You can plug an app into another app. If you have a blog engine, you can package it as a JAR file, then you can put that JAR file into another app and that app automatically has blog feature! Routing is also two-way: you can recreate URLs (reverse routing) in a typesafe way.
  • Typesafe, in the spirit of Scala. All the APIs try to be as typesafe as possible.
  • Async, in the spirit of Netty. Your request proccessing action does not have to respond immediately. Chunked response (streaming), WebSocket, and Comet (using WebSocket or long-polling) are supported.
  • Views can be written in a separate Scalate template file or Scala inline XML. Both are typesafe.
  • Sessions can be stored in cookies (more scalable) or clustered Hazelcast (more secure). Hazelcast is recommended when using continuations-based Actions, since serialized continuations are usually too big to store in cookies.
  • jQuery Validation is integrated for browser side and server side validation.
  • i18n using GNU gettext. Translation text extraction is done automatically. You can use powerful tools like Poedit for translating and merging translations. gettext is unlike most other solutions, both singular and plural forms are supported.
  • Extensive caching for faster responding. At the web server layer, small files are cached in memory, big files are sent using NIO's zero copy. All Google's best practices like conditional GET are applied. At the web framework layer you have can declare page, action, and object cache in the Rails style.

Hazelcast also gives:

  • In-process and distribued cache, you don't need separate cache servers.
  • In-process and distribued Comet (with WebSocket), you can scale Comet to multiple web servers.
+------------------+
|     Your app     |
+------------------+
|      Xitrum      |  <-- Hazelcast --> Other instances
| +--------------+ |
| | Action/View  | |
| +--------------+ |
+------------------+
|       Netty      |
| +--------------+ |
| |HTTP(S) Server| |
| +--------------+ |
+------------------+

Xitrum is open source, please join its Google group.

Quick start

$ git clone https://github.com/ngocdaothanh/xitrum-quickstart.git
$ cd xitrum-quickstart
$ sbt/sbt run

Now you have a sample project running at http://localhost:8000/ and https://localhost:4430/

After playing with the quickstart project, please read full documentation for details.

From a reader:

Wow, this is a really impressive body of work, arguably the most complete Scala framework outside of Lift (but much easier to use).

Xitrum is truly a full stack web framework, all the bases are covered, including wtf-am-I-on-the-moon extras like ETags, static file cache identifiers & auto-gzip compression. Tack on built-in JSON converter, before/around/after interceptors, request/session/cookie/flash scopes, integrated validation (server & client-side, nice), built-in cache layer (Hazelcast), i18n a la GNU gettext, Netty (with Nginx, hello blazing fast), etc. and you have, wow.

Samples