1) node.js

Mimosa is written in node.js and that needs to be installed. Download and install anything over version 0.8.0. The node.js install comes with the Node Package Manager (npm).

2) mimosa

Use npm to install Mimosa.

$ npm install -g mimosa

The -g flag installs Mimosa globally so it can be run from the command line anywhere. You may need to use sudo to install this depending on your system's setup.

If you need to install a specific version of Mimosa for compatibility reasons, then add the version to the end of the command.

$ npm install -g mimosa@0.9.0

If you want to use Mimosa with an existing app, this is the place to start.

1) Get the config

From the command line, type mimosa config and Mimosa will generate a mimosa-config.coffee file in the current directory. This file controls everything Mimosa does. For now its contents will be commented out and all of Mimosa's defaults will be in effect. While Mimosa doesn't currently deliver its config as a JavaScript file, you are welcome to transform the mimosa-config.coffee to JavaScript.

2) Tweak the config

Place the mimosa-config at the root of a project. Either change the project's codebase to match Mimosa's defaults, or change the mimosa-config to work with the project. The mimosa-config is self-documenting. Each config setting is explained inside the file. All of the configuration options are documented on the site as well.

The most important settings in the config, to get you started, are inside the top watch setting. Make sure that sourceDir, compiledDir, and javascriptDir all point to the right place in the project.

3) Fire it up

Execute mimosa watch and Mimosa will build and watch project assets. Mimosa will generate errors if something is wrong with the config.

4) Next steps?

• Get familiar with Mimosa's commands
• Browse the list of compilers.
• See how Mimosa can help serve assets or start a server.
• Learn about Mimosa's optimization options.
• Having trouble? Hit the Google group to find a solution.

If you want to build an app from scratch, or just play around with Mimosa, start here.

1) Create a new application

Inside the desired folder, create an app by executing mimosa new.

$ mimosa new nameOfApplicationHere

Follow the prompts and choose the desired meta-languages/pre-processors, server, and server view technologies. If you aren't sure which ones to choose, that's perfect. Mimosa is a great tool to learn them. For now go with the ones marked with an asterisk as they are Mimosa favorites.

2) Start the server

Change into the directory that was created and execute:

$ mimosa watch --server

Navigate to http://localhost:3000 in a browser to see the sample app. Mimosa will watch the assets directory of the project and compile changed files to the public directory. The web app serves assets in the public directory.

3) Start Coding

All set! To get the project started, Mimosa has delivered a bare bones web app with some code using the chosen technologies. Head over to the Commands tab to learn how to interact with Mimosa. If you want to play around with something meatier than the codebase that mimosa new delivers, try out a demo app.