gopher

Gopher Express

Express is the de-facto standard for a light weight web framework in node.js, but sometimes it might be nice to include just a bit more in terms of default configuration and behavior. That's what Gopher Express is for.

Words Of Caution

This module is largely an experiment in API design for a node.js web framework, and will frequently introduce API changes. Use at your own risk. However, since Gopher is just a customized version of Express with some extra features, it is easy to do anything the plain old Express way, or migrate to just using Express.

Installation

npm install --save gopher

Usage

var app = require('gopher');

app.get('/', function(request, response) {
    response.send('hello world!');
});

Visit http://localhost:3000/.

What happened?

• Creates a pre-configured Express 4 app as the base module object
• Creates and starts an HTTP server with the given express app on process.nextTick

Configuration

Your Gopher Express app uses the express app configuration API to store configuration properties for the app. Here is the default configuration, all of which can be overridden if desired:

Standard Express Configuration

• app.set('view engine', 'jade'); : Use Jade as the templating engine
• app.set('views', path.join(process.cwd(), 'views')); : Views directory is views in the webapp directory
• app.set('port', process.env.PORT || 3000); : Use an environment variable for the HTTP port, or start up on port 3000

Default Middleware

Express 4 removed much of the built-in middleware included in Express 3. These have been replaced by their standalone projects. Check them out here.

• app.use(require('morgan')('dev'));
• app.use(require('body-parser').urlencoded({extended:false}));
• app.use(require('method-override')());
• app.use(express.static(path.join(process.cwd(), 'public'))); : static content goes in public
• Development: app.use(require('errorhandler')());

Gopher-specific configuration

• app.set('gopher.autostart', true) : automatically start the created HTTP server
• app.set('gopher.middleware', true); : automatically mount default middleware
• app.set('gopher.browserify', true); : enable browserify middleware (see below)
• app.set('gopher.browserify.options', { debug: process.env.NODE_ENV !== 'production' }); : options passed to the browserify bundle command. Setting debug to false will also have the effect of uglifying your browserify bundle
• app.set('gopher.less', true); : Enable Less CSS middleware (see below)

Browserify (experimental feature, API not fully baked)

Gopher will automatically use browserify to bundle and then serve any JS files in your project's browser directory. Gopher sets up a route for /browser/:filename.js, and will browserify any files found there by that name.

Less CSS (experimental feature, API not fully baked)

Gopher will automatically mount less-middleware. TL;DR - this middleware will intercept GET requests for *.css. It will look for .less files in your public directory by the same name. If it finds one, it will Less compile that file and place it in your public directory. The resulting CSS will then be served up by Express' static middleware.

Note that this compilation step will only happen once per node process launch, so during development, any changes to your Less files will not be picked up until the next app launch. However, you're probably already using nodemon or something similar to watch your app files for changes and restart your node process, right? If not, start! This will save you lots of time. Once you start using nodemon, you can monitor both your .js and .less files for changes, and restart your node process when either file type is modified. Start your app like this from now on:

nodemon -e js,less your_app.js

API and Module Properties

require('gopher')

Load the Gopher module, create a pre-configured express web application.

Returns: An express web app

app.httpServer

An http server created for the application.

app.startServer()

Start app.httpServer and listen on app.get('port') if it hasn't already been started.

License

MIT