generator-meteor

An opinionated Meteor.js scaffolding tool for Yeoman.

Setup

Before you'll get any use out of this, you'll need to install Meteor and Meteorite and Yeoman

Here are the combined instructions at the time of this writing:

# Meteor
curl https://install.meteor.com | /bin/sh

# Meteorite
npm install -g meteorite

# Yeoman
npm install -g yo

# This generator (not yet on npm)
npm install -g git+https://github.com/cmalven/generator-meteor.git

Scaffolding

The following command will scaffold a new meteor app for you, including the iron-router, fastclick, jquery, coffeescript, and underscore packages by default, and your choice of stylus, less, or bootstrap for CSS preprocessing:

mkdir my-app && cd my-app
yo meteor

After your app is scaffolded, you'll want to install Meteorite dependencies and start your app with:

mrt install && meteor

Structure

The generated app will have the following structure by default:

/
    .meteor/
        .gitignore
        packages
        release
    client/
    	main.coffee
    	router.coffee
        vendor/
        views/
        	index/
        		index.html
        		index.coffee
        	layout/
        		layout.html
    lib/
        collections/
    packages/
    public/
    server/
        main.coffee
		methods.coffee
    	publications/
    .gitignore
	smart.json
	README.md
	index.html

Sub-Generators

We've also included a couple of Yeoman sub-generators to simplify common development tasks:

view

yo meteor:view my_view

Creates my_view.html and my_view.coffee in clients/views/my_view/

package

yo meteor:package my-package

Scaffolds and installs a new package called "my-package".

collection

yo meteor:collection animals

Creates a new collection in lib/collections/animals.coffee and publication in server/publications/animals.coffee.

charlenopires / generator-meteor