git.cworth.org Git - obsolete/notmuch-web/blob - node_modules/express/Readme.md

   1
   2 # Express
   3
   4   Insanely fast (and small) server-side JavaScript web development framework
   5   built on [node](http://nodejs.org) and [Connect](http://github.com/senchalabs/connect).
   6
   7      var app = express.createServer();
   8
   9      app.get('/', function(req, res){
  10        res.send('Hello World');
  11      });
  12
  13      app.listen(3000);
  14
  15 ## Installation
  16
  17     $ npm install express
  18
  19 or to access the `express(1)` executable install globally:
  20
  21     $ npm install -g express
  22
  23 ## Features
  24
  25   * Robust routing
  26   * Redirection helpers
  27   * Dynamic view helpers
  28   * Content negotiation
  29   * Focus on high performance
  30   * View rendering and partials support
  31   * Environment based configuration
  32   * Session based flash notifications
  33   * Built on [Connect](http://github.com/senchalabs/connect)
  34   * High test coverage
  35   * Executable for generating applications quickly
  36   * Application level view options
  37
  38 Via Connect:
  39
  40   * Session support
  41   * Cache API
  42   * Mime helpers
  43   * ETag support
  44   * Persistent flash notifications
  45   * Cookie support
  46   * JSON-RPC
  47   * Logging
  48   * and _much_ more!
  49
  50 ## Contributors
  51
  52 The following are the major contributors of Express (in no specific order).
  53
  54   * TJ Holowaychuk ([visionmedia](http://github.com/visionmedia))
  55   * Ciaran Jessup ([ciaranj](http://github.com/ciaranj))
  56   * Aaron Heckmann ([aheckmann](http://github.com/aheckmann))
  57   * Guillermo Rauch ([guille](http://github.com/guille))
  58
  59 ## More Information
  60
  61   * [express-expose](http://github.com/visionmedia/express-expose) expose objects, functions, modules and more to client-side js with ease
  62   * [express-configure](http://github.com/visionmedia/express-configuration) async configuration support
  63   * [express-messages](http://github.com/visionmedia/express-messages) flash notification rendering helper
  64   * [express-namespace](http://github.com/visionmedia/express-namespace) namespaced route support
  65   * Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
  66   * [Google Group](http://groups.google.com/group/express-js) for discussion
  67   * Visit the [Wiki](http://github.com/visionmedia/express/wiki)
  68   * Screencast - [Introduction](http://bit.ly/eRYu0O)
  69   * Screencast - [View Partials](http://bit.ly/dU13Fx)
  70   * Screencast - [Route Specific Middleware](http://bit.ly/hX4IaH)
  71   * Screencast - [Route Path Placeholder Preconditions](http://bit.ly/eNqmVs)
  72
  73 ## Node Compatibility
  74
  75 Express 1.x is compatible with node 0.2.x and connect < 1.0.
  76
  77 Express 2.x is compatible with node 0.4.x and connect 1.x
  78
  79 ## License
  80
  81 (The MIT License)
  82
  83 Copyright (c) 2009-2011 TJ Holowaychuk &lt;tj@vision-media.ca&gt;
  84
  85 Permission is hereby granted, free of charge, to any person obtaining
  86 a copy of this software and associated documentation files (the
  87 'Software'), to deal in the Software without restriction, including
  88 without limitation the rights to use, copy, modify, merge, publish,
  89 distribute, sublicense, and/or sell copies of the Software, and to
  90 permit persons to whom the Software is furnished to do so, subject to
  91 the following conditions:
  92
  93 The above copyright notice and this permission notice shall be
  94 included in all copies or substantial portions of the Software.
  95
  96 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
  97 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  98 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  99 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 100 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 101 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 102 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.