rjpalermo1/stingray

meteor-boilerplate

A starting point for MeteorJS applications. Includes flow-router, Material design Lite, Sass and more.

• Included Packages
• Installation
• Linting
• File Structure
• SEO
• Favicons and Touch Icons

Included Packages

• Collections:
  • aldeed:simple-schema
  • aldeed:collection2
• Router:
  • kadira:flow-router
  • kadira:blaze-layout
  • meteorhacks:fast-render
  • tmeasday:html5-history-api
• Authentication
  • accounts-password
  • accounts-ui
  • alanning:roles
• Sass
  • fourseven:scss
• PostCSS
  • juliancwirko:postcss
  • autoprefixer - npm
• Linting
  • eslint
  • eslint-config-airbnb
  • eslint-plugin-import
  • eslint-plugin-meteor
  • sass-lint
    • airbnb - css
• Misc:
  • Touch Support:
    • hammerjs - npm
  • Material Design Lite - NPM

Installation

1. Clone this repo to <yourapp>

https://github.com/MichaelJosephMiller/meteor-boilerplate.git <yourapp>

2. Install NPM packages

npm install

3. Set new remote url

git remote set-url <name> <newurl>

4. Start coding!

Linting

Javascript: npm run js-lint

CSS & Sass: npm run sscss-lint

File Structure

We have a common file structure we use across all of our Meteor apps. Client-only files are stored in the client directory, server-only files are stored in the server directory, and shared files are stored in the common directory. The private and public directories are for either private or public assets.

SEO

SEO is handled by dfischer:prerenderio and kadira:dochead packages. Follow instructions on the respective sites for settup.

Favicons and Touch Icons

Upload your image to http://realfavicongenerator.net/ and place the resulting images in public/images/favicons Copy and paste the HTML5 code to /client/head.html