0.1.7 • Published 10 years ago

kathinka v0.1.7

Weekly downloads
1
License
MIT
Repository
github
Last release
10 years ago

Kathinka

Node.js and Koa API REST Framework

This should simplify such simple task as creating API using Koa

NPM version build status Code Climate Dependencies Stories in Ready

Setup app

Install Slush to bootstrap app

$ npm -g install slush slush-kathinka

Install nvm to install 0.11 nodejs version

$ curl https://raw.githubusercontent.com/creationix/nvm/v0.12.1/install.sh | bash

Install MongoDB as database backend on OS X using Homebrew

brew install mongodb
ln -sfv /usr/local/opt/mongodb/*.plist ~/Library/LaunchAgents
launchctl load ~/Library/LaunchAgents/homebrew.mxcl.mongodb.plist

Bootstrap application

$ mkdir newAwesomeApp
$ cd newAwesomeApp
$ slush kathinka

Generate first resource

$ slush kathinka:resource

Start server

$ npm start

Check if app is up and running

$ curl http://localhost:54321/
{"status":"ok","version":"1"}

TODO:

https://waffle.io/wercajk/kathinka

Test:

API covered with tests so far: http://docs.kathinka.apiary.io

Run

$ npm test

Author:

Mario Vejlupek

Changelog

See releases.

License

MIT

Font Credits:

AW Conqueror, © Jean François Porchez, Typofonderie