expressling

<!DOCTYPE html> <html> <head> <title>settings.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="server.html"> server.js </a> <a class="source" href="settings.html"> settings.js </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> settings.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h1>Settings</h1> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <h2>Express</h2> </td> <td class="code"> <div class="highlight"><pre>var express = require('express') , port = 3000 , cacheAge = 24 * 60 * 60 * 1000</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <h2>Common</h2> </td> <td class="code"> <div class="highlight"><pre> , fs = require('fs') , colors = require('colors') , mime = require('mime') , gzippo = require('gzippo')</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <h1>Good and bad</h1> TODO: this should be added to Marak's <code>colors</code> (e.g. 'mystring'.bad -- which would prepend the red ✗) Don't use error/success since that could conflict with callbacks. </td> <td class="code"> <div class="highlight"><pre> , good = " ✔ ".green , bad = " ✗ ".red</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <h2>Config</h2> Based on your project's needs, you should configure <code>package.json</code> accordingly to the <a href="http://npmjs.org">npm</a> packages used. <a href="http://wiki.commonjs.org/wiki/Packages/1.0">http://wiki.commonjs.org/wiki/Packages/1.0</a> , config = require('./config') </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <h2>Mongo Session Store</h2> </td> <td class="code"> <div class="highlight"><pre> , MongoStore = require('connect-mongo')</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <h2>Cross Site Request Forgery</h2> </td> <td class="code"> <div class="highlight"><pre> , csrf = require('express-csrf')</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <h2>Stylesheets</h2> </td> <td class="code"> <div class="highlight"><pre> , stylus = require('stylus') , nib = require('nib')</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <h2>Logs</h2> </td> <td class="code"> <div class="highlight"><pre> , logs = { set: true, string: '\\n ' + ':date'.bold.underline + '\\n\\n' + ' IP: '.cyan.bold + ' ' + ':remote-addr'.white + '\\n' + ' Method: '.red.bold + ':method'.white + '\\n' + ' URL: '.blue.bold + ':url'.white + '\\n' + ' Status: '.yellow.bold + ':status'.white + '\\n' + ' User Agent: '.magenta.bold + ':user-agent'.white } , css = { count: 0, debug: false, set: true, string: function() { return '' + '\n' + good + ' Stylus has detected changes and compiled new assets' + ' ' + this.count + ' times so far' + '\n'; } }</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <h2>Set cache busting for development purposes as a view middleware helper</h2> This gets turned off in production mode, see below (e.g. <code>views/layout.jade</code> uses this for appending .css/.js w/?v=timestamp) </td> <td class="code"> <div class="highlight"><pre> , cacheBusting = true</pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> <h2>Stylus Compiler</h2> </td> <td class="code"> <div class="highlight"><pre> , compress = false // this is set to true in prod , linenos = true // this is set to false in prod , compiler = function(str, path) { if (css.set) { css.count++; var cssString = css.string(); console.log(cssString); } return stylus(str) .set('filename', path) .set('compress', compress) .set('warn', false) .set('force', false) .set('firebug', false) .set('linenos', linenos) .use(nib()); };</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> <h2>Helper functions</h2> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> <a href="http://dailyjs.com/2010/12/06/node-tutorial-5/">Return existing connection info</a> </td> <td class="code"> <div class="highlight"><pre>function mongoStoreConnectionArgs(db) { return { db: db.connections[0].db.databaseName , host: db.connections[0].db.serverConfig.host , port: db.connections[0].db.serverConfig.port , username: db.connections[0].user , password: db.connections[0].pass }; }</pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> Logout middleware helper </td> <td class="code"> <div class="highlight"><pre>function logout(req, res, next) { req.logout = function() { delete req.session.auth; }; next(); }</pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> Login middleware helper </td> <td class="code"> <div class="highlight"><pre>function loggedIn(req, res, next) { if(req.session.auth) { req.loggedIn = true; } else { req.loggedIn = false; } next(); }</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> Create a "super_admin" user and group if one does not already exist </td> <td class="code"> <div class="highlight"><pre>function createSuperAdmin(db) { var Groups = require('./schemas/groups')(db) , Users = require('./schemas/users')(db) , superGroup = { _id: "super_admin" } , superUser = { email: "admin@expressling.com" , name: { first: "SuperAdmin", last: "McLovin" } , company: "Brogrammers LLC." , password: "admin" , _group: superGroup._id }; Groups.count(superGroup, function(err, count) { if(err) console.log(err); if(count === 0) { Groups.create(superGroup, function(err, group) { if(err) console.log(err); if(group) { Users.register(superUser, function(err, user) { if(err) console.log(bad + err); if(user) console.log(good + "'super_admin' user/group created"); }); } }); } }); }</pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">¶</a> </div> Create a "user" user and group if one does not already exist </td> <td class="code"> <div class="highlight"><pre>function createUser(app, db) { var Groups = require('./schemas/groups')(db) , Users = require('./schemas/users')(db) , userGroup = { _id: "user" } , defaultUser = { email: "user@expressling.com" , name: { first: "User", last: "McLovin" } , company: "Users Rock Inc." , password: "user" , _group: userGroup._id }; Groups.count(userGroup, function(err, count) { if(err) console.log(err); if(count === 0) { Groups.create(userGroup, function(err, group) { if(err) console.log(err); if(group) { Users.register(defaultUser, function(err, user) { if(err) console.log(bad + err); if(user) console.log(good + "'user' user/group created"); return group; }); } }); } }); }</pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-19">¶</a> </div> <h2>Application Configuration</h2> </td> <td class="code"> <div class="highlight"><pre>exports.bootApplication = function(app, db) {</pre></div> </td> </tr> <tr id="section-20"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-20">¶</a> </div> <h3>Create Super Admin</h3> </td> <td class="code"> <div class="highlight"><pre> createSuperAdmin(db);</pre></div> </td> </tr> <tr id="section-21"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-21">¶</a> </div> Create User Group </td> <td class="code"> <div class="highlight"><pre> createUser(app, db);</pre></div> </td> </tr> <tr id="section-22"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-22">¶</a> </div> <h3>Default Settings</h3> </td> <td class="code"> <div class="highlight"><pre> app.configure(function() {</pre></div> </td> </tr> <tr id="section-23"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-23">¶</a> </div> Views </td> <td class="code"> <div class="highlight"><pre> app.set('views', __dirname + '/views'); app.set('view engine', 'jade'); app.use(express.bodyParser()); app.use(express.methodOverride()); app.use(express.cookieParser());</pre></div> </td> </tr> <tr id="section-24"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-24">¶</a> </div> Load Mongo session store </td> <td class="code"> <div class="highlight"><pre> app.use(express.session({ secret: "##### CHANGE THIS SECRET TO SOMETHING PRIVATE AND HASHED #####" , maxAge: cacheAge , store: new MongoStore(mongoStoreConnectionArgs(db)) }));</pre></div> </td> </tr> <tr id="section-25"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-25">¶</a> </div> Check for csrf using express-csrf module </td> <td class="code"> <div class="highlight"><pre> app.use(csrf.check());</pre></div> </td> </tr> <tr id="section-26"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-26">¶</a> </div> Favicon </td> <td class="code"> <div class="highlight"><pre> app.use(express.favicon(__dirname + '/public/favicon.ico'));</pre></div> </td> </tr> <tr id="section-27"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-27">¶</a> </div> Extra Route Middleware </td> <td class="code"> <div class="highlight"><pre> app.use(logout); app.use(loggedIn);</pre></div> </td> </tr> <tr id="section-28"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-28">¶</a> </div> Routing (keep this last) </td> <td class="code"> <div class="highlight"><pre> app.use(app.router); });</pre></div> </td> </tr> <tr id="section-29"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-29">¶</a> </div> <h3>Development Settings</h3> <pre><code>For a quick start $ node server.js Or if you have installed nodemon via: $ npm install -g nodemon $ nodemon Then point your browser to <http://localhost:8080/>. </code></pre> </td> <td class="code"> <div class="highlight"><pre> app.configure('development', function() { app.use(stylus.middleware({ src: __dirname + '/views', dest: __dirname + '/public', debug: css.debug, compile: compiler })); app.use(express.static(__dirname + '/public', { maxAge: cacheAge })); app.set('showStackError', true); if(logs.set) app.use(express.logger(logs.string)); });</pre></div> </td> </tr> <tr id="section-30"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-30">¶</a> </div> <h3>Staging Settings</h3> TODO: Build out the configuration for this mode. <code>$ NODE_ENV=staging node server.js</code> Then point your browser to <a href="http://localhost:8081/">http://localhost:8081/</a>. </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-31"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-31">¶</a> </div> <h3>Production Settings</h3> <code>$ NODE_ENV=production node server.js</code> Then point your browser to <a href="http://localhost/">http://localhost/</a>. </td> <td class="code"> <div class="highlight"><pre> app.configure('production', function() { cacheBusting = false; compress = true; linenos = false; app.use(stylus.middleware({ src: __dirname + '/views', dest: __dirname + '/public', debug: css.debug, compile: compiler }));</pre></div> </td> </tr> <tr id="section-32"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-32">¶</a> </div> Enable gzip compression is for production mode only </td> <td class="code"> <div class="highlight"><pre> app.use(gzippo.staticGzip(__dirname + '/public', { maxAge: cacheAge }));</pre></div> </td> </tr> <tr id="section-33"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-33">¶</a> </div> Disable stack error output </td> <td class="code"> <div class="highlight"><pre> app.set('showStackError', false);</pre></div> </td> </tr> <tr id="section-34"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-34">¶</a> </div> Enable view caching </td> <td class="code"> <div class="highlight"><pre> app.enable('view cache'); });</pre></div> </td> </tr> <tr id="section-35"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-35">¶</a> </div> <h3>Dynamic View Helpers</h3> </td> <td class="code"> <div class="highlight"><pre> app.dynamicHelpers({ request: function(req) { return req; }, base: function() {</pre></div> </td> </tr> <tr id="section-36"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-36">¶</a> </div> Return the app's mount-point so that urls can adjust </td> <td class="code"> <div class="highlight"><pre> return '/' === app.route ? '' : app.route; },</pre></div> </td> </tr> <tr id="section-37"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-37">¶</a> </div> <a href="https://github.com/visionmedia/express-messages/">Flash messages</a> </td> <td class="code"> <div class="highlight"><pre> messages: require('express-messages'),</pre></div> </td> </tr> <tr id="section-38"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-38">¶</a> </div> <a href="https://github.com/loopj/commonjs-date-formatting/">Dateformat helper</a> </td> <td class="code"> <div class="highlight"><pre> dateformat: function(req, res) { return require('./lib/dateformat').<span class="nx"