Mike McNeil mikermcneil

Balderdash Style Guide

The following is our development style guide. We put this together as a handy reference on how we write our code. We work on lots of projects, and using conventions offers advantages to everyone working with the code base. Writing new code is faster, maintaining old code is easier, and iterative feature development happens faster with consistent development styles used by everyone.

Even after agreeing on this guide, we've all been guilty of delighting in a bit of forbidden fruit. It's out of habit. It's not a big deal, let's just try to move towards standards as quickly as we can. In the mean time, if we see code that doesn't match up, and we have time, let's fix it.

As usual, feel free to pipe up with ideas and errata. That said, let's avoid religious wars and subjective rules-- everything below is here for a reason, and we want everybody on board with the why. Following rules without knowing why they exist is stupid. The goal is to make our code cleaner, our developm

Balderdash's Answer to "Why Node.js?"

For the chip/performance guys

Node.js is built on Google's V8 and C libraries. Here's Ryan Dahl's famous presentation about how he built Node.js

http://www.youtube.com/watch?v=jo_B4LTHi3I

From the business side

Gabe if you module.expoerts = {} you can use that objects methods and properties whereever you require it?

Mike

// foo.js
module.exports = {
 baz: 'hi'
};

	# Install Node.js and friends
	# (From https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager)
	sudo apt-get install python-software-properties python g++ make
	sudo add-apt-repository ppa:chris-lea/node.js
	sudo apt-get update
	sudo apt-get install nodejs npm nodejs-dev

	# Install other tools we like
	sudo apt-get install git emacs

	// UserController.js

	module.exports = {

	// The new way
	test1: function() {

	// contexual access to params
	// (this is probably the most valuable piece-- normalizes stuff between req.params, req.query, req.body, and socket.io)
	this.name;

	/*---------------------
	:: Session
	-> controller
	---------------------*/
	var SessionController = {

	login: function(req, res) {

	// Get password and username from request
	var username = req.param('username');

	//////////////////////////////////////////
	// Dam
	//////////////////////////////////////////
	// Simple transformer stream

	// Allows for custom iterator, prefix, and suffix

	// Set readable and writable in constructor.
	// Inherit from base stream class.
	var Dam = function(options) {

	var gameId = 7;

	async.auto({
	game: Game.find(gameId).done,
	reviews: Review.findAllByGameId(gameId).done
	}, function (err, results) {


	var response = {
	id: results.game.id,

	var fs = require('fs');
	var knox = require('knox');
	var request = require('request');

	var uri = "https://lh4.ggpht.com/N5f6FA5zPjrTH-UggaFLstYSO1za-01CbsO17ZwkghtF0k9TSzWcnCn4bybCDeIOP4cu=w124";


	// Open download stream from google
	var downStream = request(uri);