Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 113 lines (80 sloc) 3.824 kB
8675f12 @tj New doc files
tj authored
1
bf03e85 @tj No more ASCII art
tj authored
2 # Express
3
8675f12 @tj New doc files
tj authored
4 Insanely fast (and small) server-side JavaScript web development framework
a2e93eb @tj Fixed Connect links
tj authored
5 built on [node](http://nodejs.org) and [Connect](http://github.com/senchalabs/connect).
1f12c53 @tj Added Connect port notice
tj authored
6
1f9f47f @tj Readme
tj authored
7 var app = express.createServer();
afd2b4b @tj Removed alternate installation methods (use git, tarball, or npm)
tj authored
8
1f9f47f @tj Readme
tj authored
9 app.get('/', function(req, res){
4f4987e @tj misc
tj authored
10 res.send('Hello World');
1f9f47f @tj Readme
tj authored
11 });
afd2b4b @tj Removed alternate installation methods (use git, tarball, or npm)
tj authored
12
13 app.listen(3000);
3d41c61 @tj Updated docs
tj authored
14
63d02f1 @tj Install docs
tj authored
15 ## Installation
16
17 $ npm install express
18
0cb8668 @tj npm 1.x docs
tj authored
19 or to access the `express(1)` executable install globally:
20
21 $ npm install -g express
22
2732d2b @tj Updated docs
tj authored
23 ## Features
8675f12 @tj New doc files
tj authored
24
1f9f47f @tj Readme
tj authored
25 * Robust routing
54d36f3 @tj Removed traces of connect.redirect()
tj authored
26 * Redirection helpers
7eb088b @tj Added app.helpers() docs
tj authored
27 * Dynamic view helpers
2294f23 @tj Fixed connect links
tj authored
28 * Content negotiation
1f9f47f @tj Readme
tj authored
29 * Focus on high performance
30 * View rendering and partials support
2732d2b @tj Updated docs
tj authored
31 * Environment based configuration
1f9f47f @tj Readme
tj authored
32 * Session based flash notifications
2294f23 @tj Fixed connect links
tj authored
33 * Built on [Connect](http://github.com/senchalabs/connect)
a8865a5 @tj Misc docs
tj authored
34 * High test coverage
5e4d672 @tj Executable docs
tj authored
35 * Executable for generating applications quickly
4d98552 @tj Docs for "view options"
tj authored
36 * Application level view options
2732d2b @tj Updated docs
tj authored
37
38 Via Connect:
39
327d5b0 @tj Readme
tj authored
40 * Session support
088aa83 @tj Updated feature list
tj authored
41 * Cache API
8675f12 @tj New doc files
tj authored
42 * Mime helpers
8b6c4d3 @tj Updated history
tj authored
43 * ETag support
2732d2b @tj Updated docs
tj authored
44 * Persistent flash notifications
bd6f24f @aheckmann add cookie support to readme
aheckmann authored
45 * Cookie support
2732d2b @tj Updated docs
tj authored
46 * JSON-RPC
47 * Logging
48 * and _much_ more!
bbb858e @tj Added install section in readme
tj authored
49
1f9f47f @tj Readme
tj authored
50 ## Contributors
0c82752 @tj Added npm install docs
tj authored
51
1f9f47f @tj Readme
tj authored
52 The following are the major contributors of Express (in no specific order).
0c82752 @tj Added npm install docs
tj authored
53
1f9f47f @tj Readme
tj authored
54 * TJ Holowaychuk ([visionmedia](http://github.com/visionmedia))
55 * Ciaran Jessup ([ciaranj](http://github.com/ciaranj))
56 * Aaron Heckmann ([aheckmann](http://github.com/aheckmann))
6cf4629 @tj Added Guillermo Rauch to the contributor list
tj authored
57 * Guillermo Rauch ([guille](http://github.com/guille))
0c82752 @tj Added npm install docs
tj authored
58
1f9f47f @tj Readme
tj authored
59 ## More Information
e99c279 @tj Docs
tj authored
60
961146a @tj link to express-expose
tj authored
61 * [express-expose](http://github.com/visionmedia/express-expose) expose objects, functions, modules and more to client-side js with ease
b122bf2 @tj link typo
tj authored
62 * [express-configure](http://github.com/visionmedia/express-configuration) async configuration support
6813b48 @tj replaced link to express-contrib with new solo repos
tj authored
63 * [express-messages](http://github.com/visionmedia/express-messages) flash notification rendering helper
64 * [express-namespace](http://github.com/visionmedia/express-namespace) namespaced route support
1f9f47f @tj Readme
tj authored
65 * Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
66 * [Google Group](http://groups.google.com/group/express-js) for discussion
1444439 @tj Wiki
tj authored
67 * Visit the [Wiki](http://github.com/visionmedia/express/wiki)
6c0a416 @tj Added view partials screencast link
tj authored
68 * Screencast - [Introduction](http://bit.ly/eRYu0O)
69 * Screencast - [View Partials](http://bit.ly/dU13Fx)
adcfd4c @tj Added more screencast links
tj authored
70 * Screencast - [Route Specific Middleware](http://bit.ly/hX4IaH)
71 * Screencast - [Route Path Placeholder Preconditions](http://bit.ly/eNqmVs)
9973bd7 @nomiddlename Added example, extra info to Readme
nomiddlename authored
72
b311118 @tj Removed testing docs from readme
tj authored
73 ## Node Compatibility
40b3116 @tj Tasks
tj authored
74
b9e311e @tj version docs
tj authored
75 Express 1.x is compatible with node 0.2.x and connect < 1.0.
7705042 @tj docs
tj authored
76
b9e311e @tj version docs
tj authored
77 Express 2.x is compatible with node 0.4.x and connect 1.x
7eca74a @tj Updated node --version in readme
tj authored
78
31a8c7c @tj test docs
tj authored
79 ## Running Tests
80
81 To run the test suite first invoke the following command within the repo, installing the development dependencies:
82
83 $ npm install
84
85 then run the tests:
86
87 $ make test
88
fa08323 @tj Markdown
tj authored
89 ## License
8675f12 @tj New doc files
tj authored
90
91 (The MIT License)
92
9914a1e @tj copyright
tj authored
93 Copyright (c) 2009-2011 TJ Holowaychuk &lt;tj@vision-media.ca&gt;
8675f12 @tj New doc files
tj authored
94
95 Permission is hereby granted, free of charge, to any person obtaining
96 a copy of this software and associated documentation files (the
97 'Software'), to deal in the Software without restriction, including
98 without limitation the rights to use, copy, modify, merge, publish,
99 distribute, sublicense, and/or sell copies of the Software, and to
100 permit persons to whom the Software is furnished to do so, subject to
101 the following conditions:
102
103 The above copyright notice and this permission notice shall be
104 included in all copies or substantial portions of the Software.
105
106 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
107 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
108 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
109 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
110 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
111 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
4858502 @nomiddlename Asynchronous handlers working.
nomiddlename authored
112 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.