Skip to content
This repository has been archived by the owner on Jan 27, 2019. It is now read-only.

sunewt/component-koa-et-al-boilerplate

Repository files navigation

Component, Koa & friends boilerplate

Boilerplate for a Koa backend and a frontend built using component with emphasis on using light-weight dependencies.

The project incorporates following "features":

Server includes following examples:

  • Development environment with LiveReload and automatic reload on backend changes
  • Routing via koa-route
  • A * style server that always serves the client side code when no other files/endpoints are hit (used for client side routing without fragments)
  • Tests using mocha

Client includes following examples:

  • A component consisting purely of CSS (by coincidence, purecss)
  • Routing and "page module loading" via page.js
  • Including templates via domify
  • Template/view /w bindings via reactive

Inspired by and in part adapted from projects such as boilerplate-koa, component.io and others.

Requires following tools on PATH

  • Node >= 0.11.9
  • NPM

Running example

$ ./setup.sh
Installing tools
-- Component
-- Supervisor
-- Mocha
Installing dependencies

$ ./devel.sh
Installing dependencies
Setting environment to development
Starting application

(...)

Starting server in development mode
Application listening on port 9000.

Windows

  1. Hit setup.cmd (may need to be run as administrator as it contains npm global installs)
  2. Hit devel.cmd
  3. Success

unix and derivatives

  1. ./setup.sh
  2. ./devel.sh
  3. Success