source: Dev/trunk/src/node_modules/express/Readme.md

Last change on this file was 484, checked in by hendrikvanantwerpen, 11 years ago

Commit node_modules, to make checkouts and builds more deterministic.

File size: 5.8 KB
RevLine 
[484]1![express logo](http://f.cl.ly/items/0V2S1n0K1i3y1c122g04/Screen%20Shot%202012-04-11%20at%209.59.42%20AM.png)
2
3  Fast, unopinionated, minimalist web framework for [node](http://nodejs.org). [![Build Status](https://secure.travis-ci.org/visionmedia/express.png)](http://travis-ci.org/visionmedia/express) [![Dependency Status](https://gemnasium.com/visionmedia/express.png)](https://gemnasium.com/visionmedia/express)
4
5```js
6var express = require('express');
7var app = express();
8
9app.get('/', function(req, res){
10  res.send('Hello World');
11});
12
13app.listen(3000);
14```
15
16## Installation
17
18    $ npm install -g express
19
20## Quick Start
21
22 The quickest way to get started with express is to utilize the executable `express(1)` to generate an application as shown below:
23
24 Create the app:
25
26    $ npm install -g express
27    $ express /tmp/foo && cd /tmp/foo
28
29 Install dependencies:
30
31    $ npm install
32
33 Start the server:
34
35    $ node app
36
37## Features
38
39  * Built on [Connect](http://github.com/senchalabs/connect)
40  * Robust routing
41  * HTTP helpers (redirection, caching, etc)
42  * View system supporting 14+ template engines
43  * Content negotiation
44  * Focus on high performance
45  * Environment based configuration
46  * Executable for generating applications quickly
47  * High test coverage
48
49## Philosophy
50
51  The Express philosophy is to provide small, robust tooling for HTTP servers. Making
52  it a great solution for single page applications, web sites, hybrids, or public
53  HTTP APIs.
54
55  Built on Connect you can use _only_ what you need, and nothing more, applications
56  can be as big or as small as you like, even a single file. Express does
57  not force you to use any specific ORM or template engine. With support for over
58  14 template engines via [Consolidate.js](http://github.com/visionmedia/consolidate.js)
59  you can quickly craft your perfect framework.
60
61## More Information
62
63  * Join #express on freenode
64  * [Google Group](http://groups.google.com/group/express-js) for discussion
65  * Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
66  * Visit the [Wiki](http://github.com/visionmedia/express/wiki)
67  * [РусскПязычМая ЎПкуЌеМтацОя](http://jsman.ru/express/)
68  * Run express examples [online](https://runnable.com/express)
69
70## Viewing Examples
71
72Clone the Express repo, then install the dev dependencies to install all the example / test suite deps:
73
74    $ git clone git://github.com/visionmedia/express.git --depth 1
75    $ cd express
76    $ npm install
77
78then run whichever tests you want:
79
80    $ node examples/content-negotiation
81
82## Running Tests
83
84To run the test suite first invoke the following command within the repo, installing the development dependencies:
85
86    $ npm install
87
88then run the tests:
89
90    $ make test
91
92## Contributors
93
94```
95project: express
96commits: 3559
97active : 468 days
98files  : 237
99authors:
100 1891   Tj Holowaychuk          53.1%
101 1285   visionmedia             36.1%
102  182   TJ Holowaychuk          5.1%
103   54   Aaron Heckmann          1.5%
104   34   csausdev                1.0%
105   26   ciaranj                 0.7%
106   21   Robert Sköld            0.6%
107    6   Guillermo Rauch         0.2%
108    3   Dav Glass               0.1%
109    3   Nick Poulden            0.1%
110    2   Randy Merrill           0.1%
111    2   Benny Wong              0.1%
112    2   Hunter Loftis           0.1%
113    2   Jake Gordon             0.1%
114    2   Brian McKinney          0.1%
115    2   Roman Shtylman          0.1%
116    2   Ben Weaver              0.1%
117    2   Dave Hoover             0.1%
118    2   Eivind Fjeldstad        0.1%
119    2   Daniel Shaw             0.1%
120    1   Matt Colyer             0.0%
121    1   Pau Ramon               0.0%
122    1   Pero Pejovic            0.0%
123    1   Peter Rekdal Sunde      0.0%
124    1   Raynos                  0.0%
125    1   Teng Siong Ong          0.0%
126    1   Viktor Kelemen          0.0%
127    1   ctide                   0.0%
128    1   8bitDesigner            0.0%
129    1   isaacs                  0.0%
130    1   mgutz                   0.0%
131    1   pikeas                  0.0%
132    1   shuwatto                0.0%
133    1   tstrimple               0.0%
134    1   ewoudj                  0.0%
135    1   Adam Sanderson          0.0%
136    1   Andrii Kostenko         0.0%
137    1   Andy Hiew               0.0%
138    1   Arpad Borsos            0.0%
139    1   Ashwin Purohit          0.0%
140    1   Benjen                  0.0%
141    1   Darren Torpey           0.0%
142    1   Greg Ritter             0.0%
143    1   Gregory Ritter          0.0%
144    1   James Herdman           0.0%
145    1   Jim Snodgrass           0.0%
146    1   Joe McCann              0.0%
147    1   Jonathan Dumaine        0.0%
148    1   Jonathan Palardy        0.0%
149    1   Jonathan Zacsh          0.0%
150    1   Justin Lilly            0.0%
151    1   Ken Sato                0.0%
152    1   Maciej Małecki          0.0%
153    1   Masahiro Hayashi        0.0%
154```
155
156## License
157
158(The MIT License)
159
160Copyright (c) 2009-2012 TJ Holowaychuk <tj@vision-media.ca>
161
162Permission is hereby granted, free of charge, to any person obtaining
163a copy of this software and associated documentation files (the
164'Software'), to deal in the Software without restriction, including
165without limitation the rights to use, copy, modify, merge, publish,
166distribute, sublicense, and/or sell copies of the Software, and to
167permit persons to whom the Software is furnished to do so, subject to
168the following conditions:
169
170The above copyright notice and this permission notice shall be
171included in all copies or substantial portions of the Software.
172
173THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
174EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
175MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
176IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
177CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
178TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
179SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Note: See TracBrowser for help on using the repository browser.