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/expressjs/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/expressjs/express/wiki)
  44   * [Google Group](https://groups.google.com/group/express-js) for discussion
  45   * [Gitter](https://gitter.im/expressjs/express) for support and discussion
  46
  47 **PROTIP** Be sure to read [Migrating from 3.x to 4.x](https://github.com/expressjs/express/wiki/Migrating-from-3.x-to-4.x) as well as [New features in 4.x](https://github.com/expressjs/express/wiki/New-features-in-4.x).
  48
  49 ###Security Issues
  50
  51 If you discover a security vulnerability in Express, please see [Security Policies and Procedures](Security.md).
  52
  53 ## Quick Start
  54
  55   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:
  56
  57   Install the executable. The executable's major version will match Express's:
  58
  59 ```bash
  60 $ npm install -g express-generator@4
  61 ```
  62
  63   Create the app:
  64
  65 ```bash
  66 $ express /tmp/foo && cd /tmp/foo
  67 ```
  68
  69   Install dependencies:
  70
  71 ```bash
  72 $ npm install
  73 ```
  74
  75   Start the server:
  76
  77 ```bash
  78 $ npm start
  79 ```
  80
  81 ## Philosophy
  82
  83   The Express philosophy is to provide small, robust tooling for HTTP servers, making
  84   it a great solution for single page applications, web sites, hybrids, or public
  85   HTTP APIs.
  86
  87   Express does not force you to use any specific ORM or template engine. With support for over
  88   14 template engines via [Consolidate.js](https://github.com/tj/consolidate.js),
  89   you can quickly craft your perfect framework.
  90
  91 ## Examples
  92
  93   To view the examples, clone the Express repo and install the dependencies:
  94
  95 ```bash
  96 $ git clone git://github.com/expressjs/express.git --depth 1
  97 $ cd express
  98 $ npm install
  99 ```
 100
 101   Then run whichever example you want:
 102
 103 ```bash
 104 $ node examples/content-negotiation
 105 ```
 106
 107 ## Tests
 108
 109   To run the test suite, first install the dependencies, then run `npm test`:
 110
 111 ```bash
 112 $ npm install
 113 $ npm test
 114 ```
 115
 116 ## People
 117
 118 The original author of Express is [TJ Holowaychuk](https://github.com/tj) [![TJ's Gratipay][gratipay-image-visionmedia]][gratipay-url-visionmedia]
 119
 120 The current lead maintainer is [Douglas Christopher Wilson](https://github.com/dougwilson) [![Doug's Gratipay][gratipay-image-dougwilson]][gratipay-url-dougwilson]
 121
 122 [List of all contributors](https://github.com/expressjs/express/graphs/contributors)
 123
 124 ## License
 125
 126   [MIT](LICENSE)
 127
 128 [npm-image]: https://img.shields.io/npm/v/express.svg
 129 [npm-url]: https://npmjs.org/package/express
 130 [downloads-image]: https://img.shields.io/npm/dm/express.svg
 131 [downloads-url]: https://npmjs.org/package/express
 132 [travis-image]: https://img.shields.io/travis/expressjs/express/master.svg?label=linux
 133 [travis-url]: https://travis-ci.org/expressjs/express
 134 [appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/express/master.svg?label=windows
 135 [appveyor-url]: https://ci.appveyor.com/project/dougwilson/express
 136 [coveralls-image]: https://img.shields.io/coveralls/expressjs/express/master.svg
 137 [coveralls-url]: https://coveralls.io/r/expressjs/express?branch=master
 138 [gratipay-image-visionmedia]: https://img.shields.io/gratipay/visionmedia.svg
 139 [gratipay-url-visionmedia]: https://gratipay.com/visionmedia/
 140 [gratipay-image-dougwilson]: https://img.shields.io/gratipay/dougwilson.svg
 141 [gratipay-url-dougwilson]: https://gratipay.com/dougwilson/