From 32577b78beeebfdcd57b0330c26cf25f0b469d6c Mon Sep 17 00:00:00 2001 From: Sahat Yalkabov Date: Mon, 6 Jan 2014 19:31:30 -0500 Subject: [PATCH] Comments. Updated readme. --- README.md | 3 ++- app.js | 29 +++++++++++++++++++---------- 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9e861e51c3..fcb2d796c5 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,9 @@ Features -------- - Local authentication using Email and Password - OAuth2 authentication via Twitter, Facebook, Google or GitHub -- MVC Structure +- MVC Code Structure - Bootstrap 3 + Flat UI +- LESS stylesheets (auto-compiled) - Contact Form - Account Management - API Examples diff --git a/app.js b/app.js index d0be9c7e46..62ed22f0f5 100755 --- a/app.js +++ b/app.js @@ -1,3 +1,6 @@ +/** + * Module dependencies. + */ var domain = require('domain'); var express = require('express'); var fs = require('fs'); @@ -8,16 +11,23 @@ var mongoose = require('mongoose'); var passport = require('passport'); var cluster = require('cluster'); -// Load controllers +/** + * Controllers. + */ var homeController = require('./controllers/home'); var userController = require('./controllers/user'); var apiController = require('./controllers/api'); var contactController = require('./controllers/contact'); -// App Configuration (API Keys, Database URI) +/** + * API keys and Passport configuration. + */ var secrets = require('./config/secrets'); var passportConf = require('./config/passport'); +/** + * Spawn worker processes. + */ if (cluster.isMaster) { var numCPUs = require('os').cpus().length; @@ -25,7 +35,7 @@ if (cluster.isMaster) { cluster.fork(); } - cluster.on('disconnect', function(worker, code, signal) { + cluster.on('disconnect', function(worker) { console.error('worker ' + worker.process.pid + ' died'); cluster.fork(); }); @@ -34,10 +44,11 @@ if (cluster.isMaster) { mongoose.connect(secrets.db); -// Initialize express application var app = express(); -// Express Configuration + /** + * Express configuration. + */ app.set('port', process.env.PORT || 3000); app.set('views', path.join(__dirname, 'views')); app.set('view engine', 'jade'); @@ -68,15 +79,15 @@ if (cluster.isMaster) { res.render('500'); }); -// Login/Signup Routes + /** + * Routes. + */ app.get('/', homeController.index); app.get('/login', userController.getLogin); app.post('/login', userController.postLogin); app.get('/logout', userController.logout); app.get('/signup', userController.getSignup); app.post('/signup', userController.postSignup); - - // Primary Routes app.get('/contact', contactController.getContact); app.post('/contact', contactController.postContact); app.get('/account', passportConf.isAuthenticated, userController.getAccount); @@ -94,8 +105,6 @@ if (cluster.isMaster) { app.get('/api/nyt', apiController.getNewYorkTimes); app.get('/api/twitter', passportConf.isAuthenticated, apiController.getTwitter); app.get('/api/aviary', apiController.getAviary); - - // OAuth Routes app.get('/auth/facebook', passport.authenticate('facebook', { scope: 'email' })); app.get('/auth/facebook/callback', passport.authenticate('facebook', { successRedirect: '/', failureRedirect: '/login' })); app.get('/auth/github', passport.authenticate('github'));