Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Evheniy Bystrov committed Feb 5, 2017
1 parent 84ba2c2 commit 013a7e3
Showing 1 changed file with 26 additions and 30 deletions.
56 changes: 26 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,36 @@
Koa.js 2 boilerplate
====================

Koa.js 2 boilerplate for easy and fast REST API app creation

[![Build Status](https://travis-ci.org/evheniy/koa-2-boilerplate.svg?branch=master)](https://travis-ci.org/evheniy/koa-2-boilerplate)
[![Coverage Status](https://coveralls.io/repos/github/evheniy/koa-2-boilerplate/badge.svg?branch=master)](https://coveralls.io/github/evheniy/koa-2-boilerplate?branch=master)


Description
-----------
Install
-------

npm i

TESTS
-----

npm test

Server
------


npm start

OR

node --harmony app/index.js

Koa.js 2 boilerplate for easy and fast REST API app creation.
Debug:

And redis is the main storage.
DEBUG=* node --harmony app/index.js


### Modules in system:
* [koa 2](https://github.com/koajs/koa/tree/v2.x)
Expand All @@ -26,9 +46,11 @@ And redis is the main storage.
* [koa-router](https://github.com/alexmingoia/koa-router/tree/master/)
* [koa-static](https://github.com/koajs/static/tree/next)
* [koa-2-error-handler](https://github.com/evheniy/koa-2-error-handler)
* [koa-2-ioredis](https://www.npmjs.com/package/koa-2-ioredis)
* [isomorphic-fetch](https://www.npmjs.com/package/isomorphic-fetch)

### Testing:
* [debug](https://www.npmjs.com/package/debug)
* [mocha](https://mochajs.org/)
* [chai](http://chaijs.com/)
* [sinon](http://sinonjs.org/)
Expand All @@ -37,29 +59,3 @@ And redis is the main storage.
* [istanbul](https://www.npmjs.com/package/istanbul)
* [nsp](https://www.npmjs.com/package/nsp)
* [fetch-mock](http://www.wheresrhys.co.uk/fetch-mock/)



Install
-------

npm i

TESTS
-----

npm test

Server
------


npm start

OR

node --harmony app/index.js

Debug:

DEBUG=* node --harmony app/index.js

0 comments on commit 013a7e3

Please sign in to comment.