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