Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 184 lines (141 sloc) 5.824 kB
8675f12 @tj New doc files
tj authored
1
91eb275 @tj docs
tj authored
2 ![express logo](http://f.cl.ly/items/0V2S1n0K1i3y1c122g04/Screen%20Shot%202012-04-11%20at%209.59.42%20AM.png)
3d41c61 @tj Updated docs
tj authored
3
de10194 @tj build status image
tj authored
4 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)
63d02f1 @tj Install docs
tj authored
5
221a46a @tj require express in readme...
tj authored
6 ```js
7 var express = require('express');
75c29bd @tj removed createServer() in readme
tj authored
8 var app = express();
63d02f1 @tj Install docs
tj authored
9
91eb275 @tj docs
tj authored
10 app.get('/', function(req, res){
11 res.send('Hello World');
12 });
13
14 app.listen(3000);
15 ```
16
17 ## Installation
0cb8668 @tj npm 1.x docs
tj authored
18
19 $ npm install -g express
20
d033865 @tj alpha install docs
tj authored
21 To install the 3.0 alpha:
22
23 $ npm install -g express@3.0
24
723774a @tj added quick start to guide
tj authored
25 ## Quick Start
c3fbd3f @tj express(1) usage docs
tj authored
26
27 The quickest way to get started with express is to utilize the executable `express(1)` to generate an application as shown below:
28
29 Create the app:
30
31 $ npm install -g express
32 $ express /tmp/foo && cd /tmp/foo
33
34 Install dependencies:
35
91eb275 @tj docs
tj authored
36 $ npm install
c3fbd3f @tj express(1) usage docs
tj authored
37
38 Start the server:
39
91eb275 @tj docs
tj authored
40 $ node app
c3fbd3f @tj express(1) usage docs
tj authored
41
2732d2b @tj Updated docs
tj authored
42 ## Features
8675f12 @tj New doc files
tj authored
43
91eb275 @tj docs
tj authored
44 * Built on [Connect](http://github.com/senchalabs/connect)
1f9f47f @tj Readme
tj authored
45 * Robust routing
91eb275 @tj docs
tj authored
46 * HTTP helpers (redirection, caching, etc)
47 * View system supporting 14+ template engines
2294f23 @tj Fixed connect links
tj authored
48 * Content negotiation
1f9f47f @tj Readme
tj authored
49 * Focus on high performance
2732d2b @tj Updated docs
tj authored
50 * Environment based configuration
5e4d672 @tj Executable docs
tj authored
51 * Executable for generating applications quickly
91eb275 @tj docs
tj authored
52 * High test coverage
2732d2b @tj Updated docs
tj authored
53
91eb275 @tj docs
tj authored
54 ## Philosophy
2732d2b @tj Updated docs
tj authored
55
91eb275 @tj docs
tj authored
56 The Express philosophy is to provide small, robust tooling for HTTP servers. Making
57 it a great solution for single page applications, web sites, hybrids, or public
58 HTTP APIs.
59
60 Built on Connect you can use _only_ what you need, and nothing more, applications
61 can be as big or as small as you like, even a single file. Express does
62 not force you to use any specific ORM or template engine. With support for over
e8eef64 @brianloveswords Add protocol to fix link being interpreted as relative in README.md.
brianloveswords authored
63 14 template engines via [Consolidate.js](http://github.com/visionmedia/consolidate.js)
64 you can quickly craft your perfect framework.
bbb858e @tj Added install section in readme
tj authored
65
1f9f47f @tj Readme
tj authored
66 ## More Information
e99c279 @tj Docs
tj authored
67
91eb275 @tj docs
tj authored
68 * Join #express on freenode
1f9f47f @tj Readme
tj authored
69 * [Google Group](http://groups.google.com/group/express-js) for discussion
91eb275 @tj docs
tj authored
70 * Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
1444439 @tj Wiki
tj authored
71 * Visit the [Wiki](http://github.com/visionmedia/express/wiki)
40ccb59 @tj "Japanese Documentation" in Japanese 日本語ドキュメンテーション :)
tj authored
72 * [日本語ドキュメンテーション](http://hideyukisaito.com/doc/expressjs/) by [hideyukisaito](https://github.com/hideyukisaito)
7eeec91 @tj russian docs
tj authored
73 * [Русскоязычная документация](http://express-js.ru/)
3a04888 @tj docs
tj authored
74
7aea719 @tj example docs
tj authored
75 ## Viewing Examples
76
77 First install the dev dependencies to install all the example / test suite deps:
78
91eb275 @tj docs
tj authored
79 $ cd express
1763b07 @tj docs
tj authored
80 $ npm install
7aea719 @tj example docs
tj authored
81
82 then run whichever tests you want:
83
91eb275 @tj docs
tj authored
84 $ node examples/content-negotiation
7aea719 @tj example docs
tj authored
85
31a8c7c @tj test docs
tj authored
86 ## Running Tests
87
88 To run the test suite first invoke the following command within the repo, installing the development dependencies:
89
90 $ npm install
91
92 then run the tests:
93
94 $ make test
95
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
96 ## Contributors
97
98 ```
99 project: express
91eb275 @tj docs
tj authored
100 commits: 3559
101 active : 468 days
102 files : 237
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
103 authors:
91eb275 @tj docs
tj authored
104 1891 Tj Holowaychuk 53.1%
105 1285 visionmedia 36.1%
106 182 TJ Holowaychuk 5.1%
107 54 Aaron Heckmann 1.5%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
108 34 csausdev 1.0%
91eb275 @tj docs
tj authored
109 26 ciaranj 0.7%
110 21 Robert Sköld 0.6%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
111 6 Guillermo Rauch 0.2%
112 3 Dav Glass 0.1%
113 3 Nick Poulden 0.1%
91eb275 @tj docs
tj authored
114 2 Randy Merrill 0.1%
115 2 Benny Wong 0.1%
116 2 Hunter Loftis 0.1%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
117 2 Jake Gordon 0.1%
91eb275 @tj docs
tj authored
118 2 Brian McKinney 0.1%
119 2 Roman Shtylman 0.1%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
120 2 Ben Weaver 0.1%
121 2 Dave Hoover 0.1%
91eb275 @tj docs
tj authored
122 2 Eivind Fjeldstad 0.1%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
123 2 Daniel Shaw 0.1%
124 1 Matt Colyer 0.0%
125 1 Pau Ramon 0.0%
91eb275 @tj docs
tj authored
126 1 Pero Pejovic 0.0%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
127 1 Peter Rekdal Sunde 0.0%
128 1 Raynos 0.0%
129 1 Teng Siong Ong 0.0%
130 1 Viktor Kelemen 0.0%
131 1 ctide 0.0%
91eb275 @tj docs
tj authored
132 1 8bitDesigner 0.0%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
133 1 isaacs 0.0%
134 1 mgutz 0.0%
135 1 pikeas 0.0%
136 1 shuwatto 0.0%
91eb275 @tj docs
tj authored
137 1 tstrimple 0.0%
138 1 ewoudj 0.0%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
139 1 Adam Sanderson 0.0%
140 1 Andrii Kostenko 0.0%
91eb275 @tj docs
tj authored
141 1 Andy Hiew 0.0%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
142 1 Arpad Borsos 0.0%
143 1 Ashwin Purohit 0.0%
91eb275 @tj docs
tj authored
144 1 Benjen 0.0%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
145 1 Darren Torpey 0.0%
146 1 Greg Ritter 0.0%
147 1 Gregory Ritter 0.0%
148 1 James Herdman 0.0%
91eb275 @tj docs
tj authored
149 1 Jim Snodgrass 0.0%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
150 1 Joe McCann 0.0%
151 1 Jonathan Dumaine 0.0%
152 1 Jonathan Palardy 0.0%
153 1 Jonathan Zacsh 0.0%
91eb275 @tj docs
tj authored
154 1 Justin Lilly 0.0%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
155 1 Ken Sato 0.0%
91eb275 @tj docs
tj authored
156 1 Maciej Małecki 0.0%
157 1 Masahiro Hayashi 0.0%
5b1235a @tj replaced short contrib list with git-summary(1) output
tj authored
158 ```
159
fa08323 @tj Markdown
tj authored
160 ## License
8675f12 @tj New doc files
tj authored
161
162 (The MIT License)
163
91eb275 @tj docs
tj authored
164 Copyright (c) 2009-2012 TJ Holowaychuk <tj@vision-media.ca>
8675f12 @tj New doc files
tj authored
165
166 Permission is hereby granted, free of charge, to any person obtaining
167 a copy of this software and associated documentation files (the
168 'Software'), to deal in the Software without restriction, including
169 without limitation the rights to use, copy, modify, merge, publish,
170 distribute, sublicense, and/or sell copies of the Software, and to
171 permit persons to whom the Software is furnished to do so, subject to
172 the following conditions:
173
174 The above copyright notice and this permission notice shall be
175 included in all copies or substantial portions of the Software.
176
177 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
178 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
179 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
180 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
181 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
182 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
4858502 @nomiddlename Asynchronous handlers working.
nomiddlename authored
183 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.