juanifioren/meteor-coffee-boilerplate

Gives you a starting point for your new MeteorJS / Coffeescript project.

Introduction

Aims to replace meteor create your-app-name every time you want to start a new project in Meteor. This follows the basic application structure that Meteor propose (read more), but still remains very flexible, we try to go a little further, leaving you solid conventions that you can use in your projects.

Remember that is only for using with the Coffeescript programming language.

Installation & Run

First of all (and obvious), you need Meteor installed. Then:

# Clone project.
$ git clone https://github.com/juanifioren/meteor-coffee-boilerplate.git your-app-name

# Run the app.
$ cd your-app-name/ && meteor run

Remember to remove .git folder:

$ rm -rdf .git/

# OPTIONAL: Add your own repo.
$ git init
$ git remote add origin https://github.com/you/your-app-name.git

Packages

Comes bundled with a small set of packages that fit the needs of most applications when they start.

coffeescript             Javascript dialect with fewer braces and semicolons
http                     Make HTTP calls to remote servers
iron:router              Routing specifically designed for Meteor
jquery                   Manipulate the DOM using CSS selectors
meteor-platform          Include a standard set of Meteor packages in your app
mizzao:bootstrap-3       HTML, CSS, and JS framework for developing responsive, mobile first projects
service-configuration    Manage the configuration for third-party services

For security reasons autopublish and insecure packages were removed. (read more).

Folder & Files Structure

> /client
    > /lib
    > /styles
          custom.css
    > /views
          home.coffee
          home.html
      error.html
      helpers.coffee
      layout.html
      router.coffee
      startup.coffee
> /collections
> /lib
> /public
      favicon.ico
> /server
    > /lib
    > /methods
          home.coffee
      publications.coffee
      startup.coffee
  settings.json

Conventions

Now let's define some conventions for the different parts that conform our application.

Templates

A template is a snippet of HTML that can include dynamic data. Templates are defined in .html files that will be located inside client/views folder.

The name of the file will be in lowercase and separated with underscores. For example, if you define <template name="AboutMe"> then your file should be about_me.html.

If your template have some partials. Put them in the same file as your main template and call them like this <template name="AboutMe_PartialName">.

Views

Views are just the dinamyc thing of templates. They are .coffee files that contains all the helpers, events and other stuff for a specific template.

They live inside client/views folder. The filename will be the same as the .html file.

Methods

todo

Collections

todo

Publish & Subscribe

todo

Libraries

todo

Settings

todo

Contributing

todo