zs0723 / express

Sinatra inspired web development framework for node.js -- insanely fast, flexible, and simple

Express

Insanely fast (and small) server-side JavaScript web development framework built on node and Connect.

 var app = express.createServer();
 
 app.get('/', function(req, res){
   res.send('Hello World');
 });
 
 app.listen(3000);

Installation

$ npm install express

or to access the express(1) executable install globally:

$ npm install -g express

Quick Start

The quickest way to get started with express is to utilize the executable express(1) to generate an application as shown below:

Create the app:

$ npm install -g express
$ express /tmp/foo && cd /tmp/foo

Install dependencies:

$ npm install -d

Start the server:

$ node app.js

Features

• Robust routing
• Redirection helpers
• Dynamic view helpers
• Content negotiation
• Focus on high performance
• View rendering and partials support
• Environment based configuration
• Session based flash notifications
• Built on Connect
• High test coverage
• Executable for generating applications quickly
• Application level view options

Via Connect:

• Session support
• Cache API
• Mime helpers
• ETag support
• Persistent flash notifications
• Cookie support
• JSON-RPC
• Logging
• and much more!

Contributors

The following are the major contributors of Express (in no specific order).

• TJ Holowaychuk (visionmedia)
• Ciaran Jessup (ciaranj)
• Aaron Heckmann (aheckmann)
• Guillermo Rauch (guille)

More Information

• #express on freenode
• express-expose expose objects, functions, modules and more to client-side js with ease
• express-resource resourceful routing
• express-configure async configuration support
• express-messages flash notification rendering helper
• express-namespace namespaced route support
• express-params param pre-condition functions
• express-mongoose plugin for easy rendering of Mongoose async Query results
• Follow tjholowaychuk on twitter for updates
• Google Group for discussion
• Visit the Wiki
• 日本語ドキュメンテーション by hideyukisaito
• Русскоязычная документация
• Screencast - Introduction
• Screencast - View Partials
• Screencast - Route Specific Middleware
• Screencast - Route Path Placeholder Preconditions

Node Compatibility

Express 1.x is compatible with node 0.2.x and connect < 1.0.

Express 2.x is compatible with node 0.4.x and connect 1.x

Express 3.x (master branch) is compatible with node 0.6.x and connect 2.x

Viewing Examples

First install the dev dependencies to install all the example / test suite deps:

$ npm install -d

then run whichever tests you want:

$ node examples/jade/app.js

Running Tests

To run the test suite first invoke the following command within the repo, installing the development dependencies:

$ npm install

then run the tests:

$ make test

License

(The MIT License)

Copyright (c) 2009-2011 TJ Holowaychuk <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.