expressling
Version:
Expressling
51 lines (44 loc) • 15 kB
HTML
<html> <head> <title>server.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> server.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> <pre><code>Expressling
Copyright (c) 2011 Nick Baugh (niftylettuce@gmail.com)
MIT Licensed
</code></pre> </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> <p>Open source <a href="http://nodejs.org/">node.js</a> + <a href="http://expressjs.com/">express</a> application framework.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <ul>
<li>Maintainer: <a href="https://twitter.com/#!/niftylettuce">@niftylettuce</a></li>
<li>Twitter: <a href="https://twitter.com/#!/expressling">@expressling</a></li>
<li>Website: <a href="http://expressling.com/">http://expressling.com/</a></li>
<li>Source: <a href="https://github.com/niftylettuce/expressling/">https://github.com/niftylettuce/expressling/</a></li>
</ul> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <p>This was inspired by several <a href="http://nodejs.org">node.js</a> projects.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <h1>Expressling</h1> </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>Express</h2> </td> <td class="code"> <div class="highlight"><pre><span class="kd">var</span> <span class="nx">express</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'express'</span><span class="p">)</span>
<span class="p">,</span> <span class="nx">app</span> <span class="o">=</span> <span class="nx">express</span><span class="p">.</span><span class="nx">createServer</span><span class="p">()</span></pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <h2>Common</h2> </td> <td class="code"> <div class="highlight"><pre> <span class="p">,</span> <span class="nx">fs</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'fs'</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <h2>Config</h2>
<p>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.</p>
<ul>
<li><a href="http://wiki.commonjs.org/wiki/Packages/1.0">http://wiki.commonjs.org/wiki/Packages/1.0</a></li>
</ul> </td> <td class="code"> <div class="highlight"><pre> <span class="p">,</span> <span class="nx">config</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'./config'</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <h2>Settings</h2> </td> <td class="code"> <div class="highlight"><pre> <span class="p">,</span> <span class="nx">settings</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'./settings'</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <h2>Environment</h2> </td> <td class="code"> <div class="highlight"><pre> <span class="p">,</span> <span class="nx">env</span> <span class="o">=</span> <span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">NODE_ENV</span> <span class="o">||</span> <span class="s1">'development'</span>
<span class="p">,</span> <span class="nx">port</span> <span class="o">=</span> <span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">PORT</span> <span class="o">||</span> <span class="nx">config</span><span class="p">[</span><span class="nx">env</span><span class="p">].</span><span class="nx">port</span></pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> <h2>Mongoose</h2> </td> <td class="code"> <div class="highlight"><pre> <span class="p">,</span> <span class="nx">mongoose</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'mongoose'</span><span class="p">)</span>
<span class="p">,</span> <span class="nx">mongooseTypes</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">"mongoose-types"</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> <h2>Database</h2>
<p>You might want to use <a href="http://mongohq.com/">MongoHQ</a> for production
or try another provider if MongoHQ doesn't satisfy your needs.</p>
<ul>
<li><a href="http://www.mongodb.org/display/DOCS/Connections/">http://www.mongodb.org/display/DOCS/Connections/</a></li>
<li><a href="http://www.mongodb.org/display/DOCS/A+Sample+Configuration+Session/">http://www.mongodb.org/display/DOCS/A+Sample+Configuration+Session/</a></li>
</ul>
<p>Use either a <code>mongodb://</code> URI or pass <code>host, database, port, options</code>.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="p">,</span> <span class="nx">db</span> <span class="o">=</span> <span class="nx">mongoose</span><span class="p">.</span><span class="nx">connect</span><span class="p">(</span>
<span class="nx">config</span><span class="p">[</span><span class="nx">env</span><span class="p">].</span><span class="nx">db</span><span class="p">.</span><span class="nx">host</span><span class="p">,</span>
<span class="nx">config</span><span class="p">[</span><span class="nx">env</span><span class="p">].</span><span class="nx">db</span><span class="p">.</span><span class="nx">database</span><span class="p">,</span>
<span class="nx">config</span><span class="p">[</span><span class="nx">env</span><span class="p">].</span><span class="nx">db</span><span class="p">.</span><span class="nx">port</span>
<span class="p">);</span></pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> <h1>Load mongooseTypes</h1>
<p>You may want to allow all types (e.g. both email and url)</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">mongooseTypes</span><span class="p">.</span><span class="nx">loadTypes</span><span class="p">(</span><span class="nx">mongoose</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">);</span></pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> <h1>Load settings</h1> </td> <td class="code"> <div class="highlight"><pre><span class="nx">settings</span><span class="p">.</span><span class="nx">bootApplication</span><span class="p">(</span><span class="nx">app</span><span class="p">,</span> <span class="nx">db</span><span class="p">);</span>
<span class="nx">settings</span><span class="p">.</span><span class="nx">bootRoutes</span><span class="p">(</span><span class="nx">app</span><span class="p">,</span> <span class="nx">db</span><span class="p">);</span>
<span class="nx">settings</span><span class="p">.</span><span class="nx">bootErrorConfig</span><span class="p">(</span><span class="nx">app</span><span class="p">);</span></pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> <h1>Start server</h1> </td> <td class="code"> <div class="highlight"><pre><span class="nx">app</span><span class="p">.</span><span class="nx">listen</span><span class="p">(</span><span class="nx">port</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">appPort</span> <span class="o">=</span> <span class="nx">app</span><span class="p">.</span><span class="nx">address</span><span class="p">().</span><span class="nx">port</span> <span class="o">+</span> <span class="s1">''</span><span class="p">,</span> <span class="c1">// stringify that int!</span>
<span class="nx">appEnv</span> <span class="o">=</span> <span class="nx">app</span><span class="p">.</span><span class="nx">settings</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">toUpperCase</span><span class="p">();</span></pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> <h1>Colorful status</h1> </td> <td class="code"> <div class="highlight"><pre><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">''</span>
<span class="o">+</span> <span class="s1">'\n EXPRESSLING SERVER LISTENING ON PORT '</span><span class="p">.</span><span class="nx">rainbow</span>
<span class="o">+</span> <span class="s2">" "</span><span class="p">.</span><span class="nx">white</span><span class="p">.</span><span class="nx">inverse</span>
<span class="o">+</span> <span class="nx">appPort</span><span class="p">.</span><span class="nx">white</span><span class="p">.</span><span class="nx">inverse</span>
<span class="o">+</span> <span class="s2">" "</span><span class="p">.</span><span class="nx">white</span><span class="p">.</span><span class="nx">inverse</span>
<span class="o">+</span> <span class="s1">' IN '</span><span class="p">.</span><span class="nx">rainbow</span>
<span class="o">+</span> <span class="s2">" "</span><span class="p">.</span><span class="nx">white</span><span class="p">.</span><span class="nx">inverse</span>
<span class="o">+</span> <span class="nx">appEnv</span><span class="p">.</span><span class="nx">white</span><span class="p">.</span><span class="nx">inverse</span>
<span class="o">+</span> <span class="s2">" "</span><span class="p">.</span><span class="nx">white</span><span class="p">.</span><span class="nx">inverse</span>
<span class="o">+</span> <span class="s1">' MODE '</span><span class="p">.</span><span class="nx">rainbow</span>
<span class="p">);</span>
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>