generator-mithril

Yeoman generator

Getting Started

To run this version of yeoman generator. First, make sure that you have already installed yeoman:

$ npm install -g yo

To install generator-mithril from npm, run:

$ npm install -g generator-mithril

Finally, initiate the generator:

$ yo mithril

Other dependencies

1. Bower
2. Grunt
3. Sass (gem install sass)
4. Compass (gem install compass)

Known bug Mithril 0.1.15

For Browserify, change the source code to the following.

Mithril = m = new function app(window) {
...
//}(this)
}(window)

Browserify alias

Aliases for grunt browserify tasks are declared in browserify.config.js with the format “path:alias”.

Usage

Your main JavaScript file is placed in app/scripts/index.js. The main.js is generated from the grunt browserify task – I recommend that you leave leave the app/main.js unchanged, for browserify.

The version of generator uses Sass Bootstrap as its main theme. If you want to use the Compass framework, make sure that you view their docs to know what to include.

To run the server, and start building your application:

$ grunt serve

It will automatically open the webpage on your localhost:9000, or you will have to do it manuallly.

To build files for production:

$ grunt build

This also implements a subgenerator for components. Make sure you link them in your main module.

$ yo mithril:component "name" # replace name with your module name

License

MIT License