129 lines
3.9 KiB
Markdown
129 lines
3.9 KiB
Markdown
|
[](http://expressjs.com/)
|
||
|
|
|
||
|
|
Fast, unopinionated, minimalist web framework for [node](http://nodejs.org).
|
||
|
|
|
||
|
|
[](https://www.npmjs.org/package/express)
|
||
|
|
[](https://travis-ci.org/strongloop/express)
|
||
|
|
[](https://coveralls.io/r/strongloop/express)
|
||
|
|
[](https://www.gittip.com/dougwilson/)
|
||
|
|
|
||
|
|
```js
|
||
|
|
var express = require('express')
|
||
|
|
var app = express()
|
||
|
|
|
||
|
|
app.get('/', function (req, res) {
|
||
|
|
res.send('Hello World')
|
||
|
|
})
|
||
|
|
|
||
|
|
app.listen(3000)
|
||
|
|
```
|
||
|
|
|
||
|
|
**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).
|
||
|
|
|
||
|
|
### Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ npm install express
|
||
|
|
```
|
||
|
|
|
||
|
|
## Quick Start
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
Install the executable. The executable's major version will match Express's:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ npm install -g express-generator@4
|
||
|
|
```
|
||
|
|
|
||
|
|
Create the app:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ express /tmp/foo && cd /tmp/foo
|
||
|
|
```
|
||
|
|
|
||
|
|
Install dependencies:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
Start the server:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ npm start
|
||
|
|
```
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
* Robust routing
|
||
|
|
* HTTP helpers (redirection, caching, etc)
|
||
|
|
* View system supporting 14+ template engines
|
||
|
|
* Content negotiation
|
||
|
|
* Focus on high performance
|
||
|
|
* Executable for generating applications quickly
|
||
|
|
* High test coverage
|
||
|
|
|
||
|
|
## Philosophy
|
||
|
|
|
||
|
|
The Express philosophy is to provide small, robust tooling for HTTP servers, making
|
||
|
|
it a great solution for single page applications, web sites, hybrids, or public
|
||
|
|
HTTP APIs.
|
||
|
|
|
||
|
|
Express does not force you to use any specific ORM or template engine. With support for over
|
||
|
|
14 template engines via [Consolidate.js](https://github.com/visionmedia/consolidate.js),
|
||
|
|
you can quickly craft your perfect framework.
|
||
|
|
|
||
|
|
## More Information
|
||
|
|
|
||
|
|
* [Website and Documentation](http://expressjs.com/) - [[website repo](https://github.com/strongloop/expressjs.com)]
|
||
|
|
* [Github Organization](https://github.com/expressjs) for Official Middleware & Modules
|
||
|
|
* [#express](https://webchat.freenode.net/?channels=express) on freenode IRC
|
||
|
|
* Visit the [Wiki](https://github.com/strongloop/express/wiki)
|
||
|
|
* [Google Group](https://groups.google.com/group/express-js) for discussion
|
||
|
|
* [Русскоязычная документация](http://jsman.ru/express/)
|
||
|
|
* [한국어 문서](http://expressjs.kr) - [[website repo](https://github.com/Hanul/expressjs.kr)]
|
||
|
|
* Run express examples [online](https://runnable.com/express)
|
||
|
|
|
||
|
|
## Viewing Examples
|
||
|
|
|
||
|
|
Clone the Express repo, then install the dev dependencies to install all the example / test suite dependencies:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ git clone git://github.com/strongloop/express.git --depth 1
|
||
|
|
$ cd express
|
||
|
|
$ npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
Then run whichever example you want:
|
||
|
|
|
||
|
|
$ node examples/content-negotiation
|
||
|
|
|
||
|
|
You can also view live examples here:
|
||
|
|
|
||
|
|
<a href="https://runnable.com/express" target="_blank"><img src="https://runnable.com/external/styles/assets/runnablebtn.png" style="width:67px;height:25px;"></a>
|
||
|
|
|
||
|
|
## Running Tests
|
||
|
|
|
||
|
|
To run the test suite, first invoke the following command within the repo, installing the development dependencies:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
Then run the tests:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ npm test
|
||
|
|
```
|
||
|
|
|
||
|
|
### Contributors
|
||
|
|
|
||
|
|
* Author: [TJ Holowaychuk](https://github.com/visionmedia)
|
||
|
|
* Lead Maintainer: [Douglas Christopher Wilson](https://github.com/dougwilson)
|
||
|
|
* [All Contributors](https://github.com/strongloop/express/graphs/contributors)
|
||
|
|
|
||
|
|
### License
|
||
|
|
|
||
|
|
[MIT](LICENSE)
|