Readme.md

   1 [![Express Logo](https://i.cloudup.com/zfY6lL7eFa-3000x3000.png)](http://expressjs.com/)
   2
   3   Fast, unopinionated, minimalist web framework for [node](http://nodejs.org).
   4
   5   [![NPM Version][npm-image]][npm-url]
   6   [![NPM Downloads][downloads-image]][downloads-url]
   7   [![Linux Build][travis-image]][travis-url]
   8   [![Windows Build][appveyor-image]][appveyor-url]
   9   [![Test Coverage][coveralls-image]][coveralls-url]
  10
  11 ```js
  12 var express = require('express')
  13 var app = express()
  14
  15 app.get('/', function (req, res) {
  16   res.send('Hello World')
  17 })
  18
  19 app.listen(3000)
  20 ```
  21
  22 ## Installation
  23
  24 ```bash
  25 $ npm install express
  26 ```
  27
  28 ## Features
  29
  30   * Robust routing
  31   * Focus on high performance
  32   * Super-high test coverage
  33   * HTTP helpers (redirection, caching, etc)
  34   * View system supporting 14+ template engines
  35   * Content negotiation
  36   * Executable for generating applications quickly
  37
  38 ## Docs & Community
  39
  40   * [Website and Documentation](http://expressjs.com/) - [[website repo](https://github.com/strongloop/expressjs.com)]
  41   * [#express](https://webchat.freenode.net/?channels=express) on freenode IRC
  42   * [Github Organization](https://github.com/expressjs) for Official Middleware & Modules
  43   * Visit the [Wiki](https://github.com/strongloop/express/wiki)
  44   * [Google Group](https://groups.google.com/group/express-js) for discussion
  45   * [Русскоязычная документация](http://jsman.ru/express/)
  46   * [한국어 문서](http://expressjs.kr) - [[website repo](https://github.com/Hanul/expressjs.kr)]
  47
  48 **PROTIP** Be sure to read [Migrating from 3.x to 4.x](https://github.com/strongloop/express/wiki/Migrating-from-3.x-to-4.x) as well as [New features in 4.x](https://github.com/strongloop/express/wiki/New-features-in-4.x).
  49
  50 ## Quick Start
  51
  52   The quickest way to get started with express is to utilize the executable [`express(1)`](https://github.com/expressjs/generator) to generate an application as shown below:
  53
  54   Install the executable. The executable's major version will match Express's:
  55
  56 ```bash
  57 $ npm install -g express-generator@4
  58 ```
  59
  60   Create the app:
  61
  62 ```bash
  63 $ express /tmp/foo && cd /tmp/foo
  64 ```
  65
  66   Install dependencies:
  67
  68 ```bash
  69 $ npm install
  70 ```
  71
  72   Start the server:
  73
  74 ```bash
  75 $ npm start
  76 ```
  77
  78 ## Philosophy
  79
  80   The Express philosophy is to provide small, robust tooling for HTTP servers, making
  81   it a great solution for single page applications, web sites, hybrids, or public
  82   HTTP APIs.
  83
  84   Express does not force you to use any specific ORM or template engine. With support for over
  85   14 template engines via [Consolidate.js](https://github.com/tj/consolidate.js),
  86   you can quickly craft your perfect framework.
  87
  88 ## Examples
  89
  90   To view the examples, clone the Express repo and install the dependencies:
  91
  92 ```bash
  93 $ git clone git://github.com/strongloop/express.git --depth 1
  94 $ cd express
  95 $ npm install
  96 ```
  97
  98   Then run whichever example you want:
  99
 100 ```bash
 101 $ node examples/content-negotiation
 102 ```
 103
 104 ## Tests
 105
 106   To run the test suite, first install the dependencies, then run `npm test`:
 107
 108 ```bash
 109 $ npm install
 110 $ npm test
 111 ```
 112
 113 ## People
 114
 115 The original author of Express is [TJ Holowaychuk](https://github.com/tj) [![TJ's Gratipay][gratipay-image-visionmedia]][gratipay-url-visionmedia]
 116
 117 The current lead maintainer is [Douglas Christopher Wilson](https://github.com/dougwilson) [![Doug's Gratipay][gratipay-image-dougwilson]][gratipay-url-dougwilson]
 118
 119 [List of all contributors](https://github.com/strongloop/express/graphs/contributors)
 120
 121 ## License
 122
 123   [MIT](LICENSE)
 124
 125 [npm-image]: https://img.shields.io/npm/v/express.svg
 126 [npm-url]: https://npmjs.org/package/express
 127 [downloads-image]: https://img.shields.io/npm/dm/express.svg
 128 [downloads-url]: https://npmjs.org/package/express
 129 [travis-image]: https://img.shields.io/travis/strongloop/express/master.svg?label=linux
 130 [travis-url]: https://travis-ci.org/strongloop/express
 131 [appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/express/master.svg?label=windows
 132 [appveyor-url]: https://ci.appveyor.com/project/dougwilson/express
 133 [coveralls-image]: https://img.shields.io/coveralls/strongloop/express/master.svg
 134 [coveralls-url]: https://coveralls.io/r/strongloop/express?branch=master
 135 [gratipay-image-visionmedia]: https://img.shields.io/gratipay/visionmedia.svg
 136 [gratipay-url-visionmedia]: https://gratipay.com/visionmedia/
 137 [gratipay-image-dougwilson]: https://img.shields.io/gratipay/dougwilson.svg
 138 [gratipay-url-dougwilson]: https://gratipay.com/dougwilson/