A Koa.js Application Boilerplate
Koa.js is a modern Web framework designed by the team behind Express.js. While being lean and minimalistic, it has all the functionality needed in order to create robust and powerful Web-applications.
An average Web-application often contains some common components (e.g. routing, public folder, view rendering, etc.), and Koan.js provides you with a boilerplate having many of these components already in place. Also, it proposes a way to organize application features.
It's just one of many, many possible ways. The beauty of Koa.js (or Express.js) is in its incredible flexibility giving you freedom to organize your application however you feel is right. But if you want just save your time and go with an existing solution, Koan.js definitely worth a shot.
sudo npm install -g koan
koan new myappcreates a subfolder
myappin the current directory with the new application boilerplate in it.
npm installto install dependencies.
- Start your application with
koan start(or just usual
- Run tests with
- Add or disable middleware your new Koan.js application requires in
- Configure your routes in
- Configure view scripts templating in
- Set other application options in
config/options.js, they will be available during runtime via
koan controller <controllerName>while inside the project root in order to generate a new controller.
koan model <modelName>while inside the project root in order to generate a new model.
koan resource <resourceName>while inside the project root in order to generate both controller and model (no automated RESTful routing generation is implemented at this point, so you will have to describe the routes manually).
More scaffolds to come.
- Koa.js as the main application framework,
- Koan-views for template rendering with layouts,
- Koan-errors for error handling,
- Koa-route for routing,
- Lodash utilities,
- Commander for CLI,
- Fs-extra for recursive file system operations,
- Koa-compose to compose middleware.
- are welcome;
- should be tested;
- should follow Koa.js coding style.
Copyright (c) 2013-2014 Ruslan Bredikhin