Fork me on GitHub


So, you want to work on this open source project? Awesome! Here's what you need to know.

Setting Up Your Environment

The Github Repository has everything you need to work on Treema. You'll need Node, NPM and Git installed.

  1. Clone the repository
    git clone
  2. Go to the directory and NPM install
    npm install

Bam. You're done.

Running The Environment

From the treema directory, run:

Convenience Tip

To make starting the dev environment easier, put the bin folder in your PATH. Do that by putting in a line like this in your .profile file:


I also like to set up Mac OS X Window Groups to really make it easy. To do that:

  1. Go to Terminal preferences and add a Treema profile under the Settings tab, running treema-brunch when it opens (in the Shell inner tab).
  2. Open a Terminal with that profile (double clicking it works) and set it just where you want it.
  3. Close all other open terminals.
  4. Under the Window menu, choose "Save Windows As Group..." and make one for Treema.

Now, whenever you want to work on Treema, open that Window group from the same menu. So easy.

The environment is a Node.js server. It's used for several things:

Brunch both runs this server, and also handles trans-compiling from Sass and CoffeeScript to CSS and JavaScript. Assuming you've started brunch, you should be able to access the test page at


If that worked, you can edit the CoffeeScript files and view changes in scratch.html or any of the html files in /dev.

Things to keep in mind

What to work on?

We have a handful of advanced features we, ourselves, want next:

You could always also add more tests, add more nodes for common cases, or handle reported issues.