Development environment

In this page, we explain how to build Akka Extras (and most of other Eigengo projects).

#Building The project is self-contained; once you have its source code and the required build tools, you can start hacking.

##Linux / OS X To build and develop this project, you will need

• JDK 1.7: OpenJDK or Oracle JDK are OK; other JDKs should be OK, but we have not tested them.
• sbt-extras

Download & install the JDK; then grab the sbt script and put it to some sensible directory and add that directory to your PATH variable. A good location is /usr/local/bin, which is in PATH on most Linuxen.

Then clone this repository to some working directory, say $HOME/sandbox/akka-patterns. Change to that directory and run sbt test. This should download all dependencies, including test dependencies, and run all tests. The output should match

Detected sbt version 0.12.2
Using /Users/janmachacek/.sbt/0.12.2 as sbt dir, -sbt-dir to override.
...

[info] Passed: : Total 2, Failed 0, Errors 0, Passed 2, Skipped 0
[success] Total time: 15 s, completed Apr 30, 2013 9:50:44 AM

This means that the project builds & tests pass. You are now ready to explore the source code in your favourite editor. vim works like a charm, I hear that emacs has now decided to include a text editor, Sublime Text is also a good option. If you want a full-blown IDE, you can use IntelliJ IDEA or Scala IDE. For IntelliJ IDEA, you can generate its project files by running sbt gen-idea and then using IntelliJ IDEA to open the project's directory.

##Windows (I am so sorry.)

#Publishing If you want to start using the cutting-edge versions of Akka Extras, you will need to publish the artefacts to your local .ivy2 store. To do so, you need to run sbt publish-local.

#Contributing We would love to have your contributions & improvements. All you have to do is to send a pull request and we'll get back to you as soon as we can.