(add) router/config documentation

server.js

@@ -1,10 +1,14 @@
-// Imports the server configuration
-var app = require('./server/config');
 
-// Sets port to deployed port or local 9000
+/****************
+  Server Engine
+****************/
+
+/*
+  Runs the configuration and starts up the server
+*/
+var app = require('./server/config');
 var port = process.env.PORT || 9000;
 
-// Starts server on provided port
 app.listen(port, function() {
-  console.log('listening on 9000');
+  console.log('listening on', port);
 });

server/config.js

@@ -1,37 +1,55 @@
-/*  Imports  */
+
+/****************
+  Server Config
+****************/
+
+/*
+  Sets up the routing for the server, sending each
+  API request to its associated controller
+*/
+
+/* * Imports * */
+
 var express = require('express');
 var bodyParser = require('body-parser');
 var morgan = require('morgan');
 
-/*  Declarations  */
-module.exports = app = express();
-var topRouter = express.Router();
-var peopleRouter = express.Router();
-var twitterRouter = express.Router();
-var contextRouter = express.Router();
-var sitesRouter = express.Router();
+/* * Middleware * */
 
-/*  Configuration  */
+module.exports = app = express();
 app.use(bodyParser.json());
-// app.use(morgan('dev'));
 app.use(express.static(__dirname + '/../client/dist/public'));
 
+/* * API Routing * */
+
+var topRouter = express.Router();
 app.use('/api/top', topRouter);
 require('./router.js').top(topRouter);
 
+var peopleRouter = express.Router();
 app.use('/api/people', peopleRouter);
 require('./router.js').people(peopleRouter);
 
+var twitterRouter = express.Router();
 app.use('/api/twitter', twitterRouter);
 require('./router.js').twitter(twitterRouter);
 
+var contextRouter = express.Router();
 app.use('/api/context', contextRouter);
 require('./router.js').context(contextRouter);
 
+var sitesRouter = express.Router();
 app.use('/api/sites', sitesRouter);
 require('./router.js').sites(sitesRouter);
 
-/*  serves index on default  */
+var facebookRouter = express.Router();
+app.use('/api/facebook', facebookRouter);
+require('./router.js').facebook(facebookRouter);
+
+/*
+  Serves index on default
+  TODO: Fix this
+*/
 app.use(function(req, res) {
   res.redirect('/');
 });

server/router.js

@@ -1,12 +1,24 @@
 
-// Declaring the controllers
+/****************
+  Server Router
+****************/
+
+/*
+  Sets up the routing for the server, sending each
+  API request to its associated controller
+*/
+
+/* * Imports * */
+
 var topController = require('./database/top/controller');
 var peopleController = require('./database/people/controller');
 var twitterController = require('./database/twitter/controller');
 var contextController = require('./database/context/controller');
 var sitesController = require('./database/sites/controller');
+var facebookController = require('./database/facebook/controller');
+
+/* * API route directing * */
 
-// Directing the given routes to the correct controllers
 module.exports.top = function(app) {
   app.param('id', topController.attachParam);
   app.get('/:id', topController.get);
@@ -19,7 +31,6 @@ module.exports.people = function(app) {
   app.post('/', peopleController.post);
 };
 
-// Here for maybe future implementation?
 module.exports.twitter = function(app) {
   app.param('id', twitterController.attachParam);
   app.get('/:id', twitterController.get);
@@ -34,3 +45,8 @@ module.exports.sites = function(app) {
   app.param('id', sitesController.attachParam);
   app.get('/:id', sitesController.get);
 };
+
+module.exports.facebook = function(app) {
+  app.param('id', facebookController.attachParam);
+  app.get('/:id', facebookController.get);
+};