koa-lite/Readme.md

96 lines
3.1 KiB
Markdown
Raw Normal View History

<img src="https://dl.dropboxusercontent.com/u/6396913/koa/logo.png" alt="koa middleware framework for nodejs" width="255px" />
2013-08-17 07:15:57 +00:00
2014-07-26 06:43:41 +00:00
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
2013-11-08 09:16:26 +00:00
2013-08-17 07:15:57 +00:00
Expressive middleware for node.js using generators via [co](https://github.com/visionmedia/co)
2013-12-21 05:45:27 +00:00
to make web applications and APIs more enjoyable to write. Koa's middleware flow in a stack-like manner allowing you to perform actions downstream, then filter and manipulate the response upstream. Koa's use of generators also greatly increases the readability and robustness of your application.
2013-08-17 07:15:57 +00:00
Only methods that are common to nearly all HTTP servers are integrated directly into Koa's small ~550 SLOC codebase. This
2013-08-17 07:33:28 +00:00
includes things like content-negotiation, normalization of node inconsistencies, redirection, and a few others.
2013-08-17 07:15:57 +00:00
2013-08-17 07:33:28 +00:00
No middleware are bundled with koa. If you prefer to only define a single dependency for common middleware, much like Connect, you may use
2013-08-17 07:15:57 +00:00
[koa-common](https://github.com/koajs/common).
## Installation
```
$ npm install koa
```
2013-12-19 06:58:44 +00:00
To use Koa you must be running __node 0.11.9__ or higher for generator support, and must run node(1)
with the `--harmony` flag. If you don't like typing this, add an alias to your shell profile:
2013-08-17 07:15:57 +00:00
```
alias node='node --harmony'
2013-08-17 07:15:57 +00:00
```
## Community
- [API](docs/api/index.md) documentation
2014-09-08 00:42:30 +00:00
- [Badgeboard](https://koajs.github.io/badgeboard) and list of official modules
2013-12-07 23:09:09 +00:00
- [Examples](https://github.com/koajs/examples)
2013-11-12 09:43:27 +00:00
- [Middleware](https://github.com/koajs/koa/wiki) list
2013-09-17 13:48:36 +00:00
- [Wiki](https://github.com/koajs/koa/wiki)
2013-08-17 07:15:57 +00:00
- [G+ Community](https://plus.google.com/communities/101845768320796750641)
- [Reddit Community](http://reddit.com/r/koajs)
2013-08-17 07:15:57 +00:00
- [Mailing list](https://groups.google.com/forum/#!forum/koajs)
2013-09-03 01:25:17 +00:00
- [Guide](docs/guide.md)
2013-08-21 05:07:00 +00:00
- [FAQ](docs/faq.md)
2014-07-26 06:49:23 +00:00
- [中文文档](http://koajs.cn/)
2013-08-21 05:07:20 +00:00
- __#koajs__ on freenode
2013-08-17 07:15:57 +00:00
## Getting started
2014-07-26 06:43:41 +00:00
- [kick-off-koa](https://github.com/koajs/kick-off-koa) - An intro to koa via a set of self-guided workshops.
- [workshop](https://github.com/koajs/workshop) - A workshop to learn the basics of koa, Express' spiritual successor.
2013-08-17 07:15:57 +00:00
## Example
```js
var koa = require('koa');
var app = koa();
// logger
2013-11-08 00:31:16 +00:00
app.use(function *(next){
var start = new Date;
yield next;
var ms = new Date - start;
console.log('%s %s - %s', this.method, this.url, ms);
2013-08-17 07:15:57 +00:00
});
// response
2013-11-08 00:31:16 +00:00
app.use(function *(){
this.body = 'Hello World';
2013-08-17 07:15:57 +00:00
});
app.listen(3000);
```
## Running tests
```
$ make test
```
2013-08-26 02:16:57 +00:00
## Authors
- [TJ Holowaychuk](https://github.com/visionmedia)
- [Jonathan Ong](https://github.com/jonathanong)
2013-11-08 00:31:16 +00:00
- [Julian Gruber](https://github.com/juliangruber)
- [Yiyu He](https://github.com/dead-horse)
2013-08-26 02:16:57 +00:00
2013-08-17 07:15:57 +00:00
# License
MIT
2014-10-09 17:59:57 +00:00
[npm-image]: https://img.shields.io/npm/v/koa.svg?style=flat-square
[npm-url]: https://npmjs.org/package/koa
2014-10-09 17:59:57 +00:00
[travis-image]: https://img.shields.io/travis/koajs/koa.svg?style=flat-square
[travis-url]: https://travis-ci.org/koajs/koa
2014-10-09 17:59:57 +00:00
[coveralls-image]: https://img.shields.io/coveralls/koajs/koa.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/koajs/koa?branch=master