Sails Boilerplate

An opinionated configuration

---

• sailsjs web framework

  An ambitious server side framework.

• compass styles

  • scss

    Syntactically awesome style sheets.

  • normalize

    A CSS reset snippet.

• icons

  • svgstore

    Concatenates a bunch of svg files into a single svg file.

  • webfont

    Takes a bunch of svg files and produces a webfont.

• passport

  A library which manages authentication with different OAuth providers.

• jasmine

  A testing suite for javascript.

• jade templating

  A node oriented html templating language.

• marionette (SPA) frontend

  A Backbone framework for building massive, maintainable single page applications.

  • backbone

    Gives backbone to your frontend architecture.

  • jquery

    The popular DOM selector library.

  • lodash

    A powerful and efficient javascript utilities library.

  • backbone.sails

    A plugin which integrates Sails into Backbone.

• mongodb database

  • mongodb

    The mongodb driver.

  • connect-mongo

    A session-store which persists to mongodb.

• automation

  • cron

    A node package to repeat scheduled tasks on the server.

  • browsersync

    Set's up a proxy server to sails, which refreshes in the browser when files are changed.

  • nodemon

    Reboot's the server when server side code changes.

  • forever

    Continuously runs a process (app.js) reinitializing if there is an error.

• node-debug

  Set's up a browser based window for debugging server side code.

• bower package manager

  • bower

    A package manager for front end javascript libraries.

  • grunt-bower

    The grunt task which automates the integration of bower packages into the sails build system.

---

TO START

• npm install .
• bower install .

Development Environment

• grunt watchAll
• grunt bootDev

Debugging Environment

• grunt buildDev
• grunt debug

Production Environment

• configure config/env/production
• set PORT=80 & set NODE_ENV=production (windows)
• grunt buildProd
• forever start app.js --prod
• forever stop app.js

External Dependencies

• ruby
• gem update --system && gem install compass
• npm install -g forever mongodb node-debug bower browser-sync
• ttfautohont
• fontforge (make sure bin folder is available to your environment)