Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 103 lines (70 sloc) 3.14 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
2732d2b @tj Updated docs
tj authored
5 built on [node](http://nodejs.org) and [Connect](http://github.com/extjs/Connect).
1f12c53 @tj Added Connect port notice
tj authored
6
1f9f47f @tj Readme
tj authored
7 var app = express.createServer();
8
9 app.get('/', function(req, res){
10 res.send('Hello World');
11 });
12
3d41c61 @tj Updated docs
tj authored
13 app.listen(3000);
14
63d02f1 @tj Install docs
tj authored
15 ## Installation
16
17 npm:
18
19 $ npm install express
20
21 curl (or similar):
22
23 $ curl -# http://github.com/extjs/Connect/raw/master/install.sh | sh
24
25 git clone or tarball:
26
27 $ make install
28
2732d2b @tj Updated docs
tj authored
29 ## Features
8675f12 @tj New doc files
tj authored
30
1f9f47f @tj Readme
tj authored
31 * Robust routing
54d36f3 @tj Removed traces of connect.redirect()
tj authored
32 * Redirection helpers
1f9f47f @tj Readme
tj authored
33 * Focus on high performance
34 * View rendering and partials support
2732d2b @tj Updated docs
tj authored
35 * Environment based configuration
1f9f47f @tj Readme
tj authored
36 * Session based flash notifications
37 * Built on [Connect](http://extjs.github.com/Connect)
2732d2b @tj Updated docs
tj authored
38
39 Via Connect:
40
327d5b0 @tj Readme
tj authored
41 * Session support
088aa83 @tj Updated feature list
tj authored
42 * Cache API
8675f12 @tj New doc files
tj authored
43 * Mime helpers
8b6c4d3 @tj Updated history
tj authored
44 * ETag support
2732d2b @tj Updated docs
tj authored
45 * Persistent flash notifications
bd6f24f @aheckmann add cookie support to readme
aheckmann authored
46 * Cookie support
2732d2b @tj Updated docs
tj authored
47 * JSON-RPC
48 * Logging
49 * and _much_ more!
bbb858e @tj Added install section in readme
tj authored
50
1f9f47f @tj Readme
tj authored
51 ## Contributors
0c82752 @tj Added npm install docs
tj authored
52
1f9f47f @tj Readme
tj authored
53 The following are the major contributors of Express (in no specific order).
0c82752 @tj Added npm install docs
tj authored
54
1f9f47f @tj Readme
tj authored
55 * TJ Holowaychuk ([visionmedia](http://github.com/visionmedia))
56 * Ciaran Jessup ([ciaranj](http://github.com/ciaranj))
57 * Aaron Heckmann ([aheckmann](http://github.com/aheckmann))
0c82752 @tj Added npm install docs
tj authored
58
1f9f47f @tj Readme
tj authored
59 ## More Information
e99c279 @tj Docs
tj authored
60
1f9f47f @tj Readme
tj authored
61 * Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
62 * [Google Group](http://groups.google.com/group/express-js) for discussion
63 * [JavaScript Extensions & Utilities](http://github.com/visionmedia/ext.js)
64 * [JavaScript Sass](http://github.com/visionmedia/sass.js)
65 * [JavaScript Haml](http://github.com/visionmedia/haml.js)
66 * [JavaScript Jade](http://github.com/visionmedia/jade) spiritual successor of Haml
9973bd7 @nomiddlename Added example, extra info to Readme
nomiddlename authored
67
34a55ba @tj Readme for testing
tj authored
68 ## Running Tests
69
2732d2b @tj Updated docs
tj authored
70 Express uses the [Expresso](http://github.com/visionmedia/expresso) TDD
40c5bc0 @tj Docs
tj authored
71 framework to write and run elegant test suites extremely fast. First `$ git submodule update --init`, then run:
fa08323 @tj Markdown
tj authored
72
8e23ebb @tj Updated readme with new spec running info
tj authored
73 $ make test
fde2bfc @tj Link to Mojo mustache templates
tj authored
74
2d1c98a @tj Docs for stable / edge
tj authored
75 The latest release of Express is compatible with node --version:
40b3116 @tj Tasks
tj authored
76
2732d2b @tj Updated docs
tj authored
77 v0.1.100
2d1c98a @tj Docs for stable / edge
tj authored
78
fa08323 @tj Markdown
tj authored
79 ## License
8675f12 @tj New doc files
tj authored
80
81 (The MIT License)
82
7a69100 @tj Updated copyright
tj authored
83 Copyright (c) 2009-2010 TJ Holowaychuk <tj@vision-media.ca>
8675f12 @tj New doc files
tj authored
84
85 Permission is hereby granted, free of charge, to any person obtaining
86 a copy of this software and associated documentation files (the
87 'Software'), to deal in the Software without restriction, including
88 without limitation the rights to use, copy, modify, merge, publish,
89 distribute, sublicense, and/or sell copies of the Software, and to
90 permit persons to whom the Software is furnished to do so, subject to
91 the following conditions:
92
93 The above copyright notice and this permission notice shall be
94 included in all copies or substantial portions of the Software.
95
96 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
97 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
98 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
99 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
100 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
101 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
4858502 @nomiddlename Asynchronous handlers working.
nomiddlename authored
102 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.