Use npm to install Mimosa.
$ npm install -g mimosa
-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 firstname.lastname@example.org
If you want to use Mimosa with an existing app, this is the place to start.
From the command line, type
mimosa config and Mimosa will generate a
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
mimosa watch and Mimosa will build and watch project assets. Mimosa will generate errors if something is wrong with the config.
If you want to build an app from scratch, or just play around with Mimosa, start here.
Inside the desired folder, create an app by executing
$ 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.
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.
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.
Before creating your own app, play around with someone else's! Download an app from GitHub and use Mimosa's command line interface to play with the code and get comfortable with Mimosa and the technologies inside the demo apps.
As more demo apps are built, they'll get added here. If you put a little something together using Mimosa let us know so we can add it to the list! Either open an issue or shoot a message to @mimosajs.
Mimosa needs skeletons. Check out the documentation and whip something up real quick using the technologies you love so that others can benefit.