deps: proxy-addr@~2.0.7
[express.git] / Readme.md
blobb60d588c4132cf626c50dc16e343558b45f96c0f
1 [![Express Logo](https://i.cloudup.com/zfY6lL7eFa-3000x3000.png)](http://expressjs.com/)
3   Fast, unopinionated, minimalist web framework for [node](http://nodejs.org).
5   [![NPM Version][npm-image]][npm-url]
6   [![NPM Downloads][downloads-image]][downloads-url]
7   [![Linux Build][ci-image]][ci-url]
8   [![Windows Build][appveyor-image]][appveyor-url]
9   [![Test Coverage][coveralls-image]][coveralls-url]
11 ```js
12 const express = require('express')
13 const app = express()
15 app.get('/', function (req, res) {
16   res.send('Hello World')
19 app.listen(3000)
20 ```
22 ## Installation
24 This is a [Node.js](https://nodejs.org/en/) module available through the
25 [npm registry](https://www.npmjs.com/).
27 Before installing, [download and install Node.js](https://nodejs.org/en/download/).
28 Node.js 0.10 or higher is required.
30 If this is a brand new project, make sure to create a `package.json` first with
31 the [`npm init` command](https://docs.npmjs.com/creating-a-package-json-file).
33 Installation is done using the
34 [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
36 ```bash
37 $ npm install express
38 ```
40 Follow [our installing guide](http://expressjs.com/en/starter/installing.html)
41 for more information.
43 ## Features
45   * Robust routing
46   * Focus on high performance
47   * Super-high test coverage
48   * HTTP helpers (redirection, caching, etc)
49   * View system supporting 14+ template engines
50   * Content negotiation
51   * Executable for generating applications quickly
53 ## Docs & Community
55   * [Website and Documentation](http://expressjs.com/) - [[website repo](https://github.com/expressjs/expressjs.com)]
56   * [#express](https://webchat.freenode.net/?channels=express) on freenode IRC
57   * [GitHub Organization](https://github.com/expressjs) for Official Middleware & Modules
58   * Visit the [Wiki](https://github.com/expressjs/express/wiki)
59   * [Google Group](https://groups.google.com/group/express-js) for discussion
60   * [Gitter](https://gitter.im/expressjs/express) for support and discussion
62 **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).
64 ### Security Issues
66 If you discover a security vulnerability in Express, please see [Security Policies and Procedures](Security.md).
68 ## Quick Start
70   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:
72   Install the executable. The executable's major version will match Express's:
74 ```bash
75 $ npm install -g express-generator@4
76 ```
78   Create the app:
80 ```bash
81 $ express /tmp/foo && cd /tmp/foo
82 ```
84   Install dependencies:
86 ```bash
87 $ npm install
88 ```
90   Start the server:
92 ```bash
93 $ npm start
94 ```
96   View the website at: http://localhost:3000
98 ## Philosophy
100   The Express philosophy is to provide small, robust tooling for HTTP servers, making
101   it a great solution for single page applications, websites, hybrids, or public
102   HTTP APIs.
104   Express does not force you to use any specific ORM or template engine. With support for over
105   14 template engines via [Consolidate.js](https://github.com/tj/consolidate.js),
106   you can quickly craft your perfect framework.
108 ## Examples
110   To view the examples, clone the Express repo and install the dependencies:
112 ```bash
113 $ git clone git://github.com/expressjs/express.git --depth 1
114 $ cd express
115 $ npm install
118   Then run whichever example you want:
120 ```bash
121 $ node examples/content-negotiation
124 ## Tests
126   To run the test suite, first install the dependencies, then run `npm test`:
128 ```bash
129 $ npm install
130 $ npm test
133 ## Contributing
135 [Contributing Guide](Contributing.md)
137 ## People
139 The original author of Express is [TJ Holowaychuk](https://github.com/tj)
141 The current lead maintainer is [Douglas Christopher Wilson](https://github.com/dougwilson)
143 [List of all contributors](https://github.com/expressjs/express/graphs/contributors)
145 ## License
147   [MIT](LICENSE)
149 [ci-image]: https://img.shields.io/github/workflow/status/expressjs/express/ci/master.svg?label=linux
150 [ci-url]: https://github.com/expressjs/express/actions?query=workflow%3Aci
151 [npm-image]: https://img.shields.io/npm/v/express.svg
152 [npm-url]: https://npmjs.org/package/express
153 [downloads-image]: https://img.shields.io/npm/dm/express.svg
154 [downloads-url]: https://npmcharts.com/compare/express?minimal=true
155 [appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/express/master.svg?label=windows
156 [appveyor-url]: https://ci.appveyor.com/project/dougwilson/express
157 [coveralls-image]: https://img.shields.io/coveralls/expressjs/express/master.svg
158 [coveralls-url]: https://coveralls.io/r/expressjs/express?branch=master