Instant-Skeleton

Best opinionated realtime framework to lift heavy functionality lightening quick with Node.JS

PROTIP Be sure to peruse our fancy documentation

FORK ME Pull request friendly!

Quick Start

$ npm install && npm test && npm start

Overview

Building your SEO-friendly realtime application is simple: add Pages (isomorphic bits of React) and Services (RESTful & Realtime API endpoints). As an example, a basic TODO application is implemented herein.

• Add a New Page

    $ vim server/pages.ls    # add a route here
  

• Add a New RESTful Service

    $ vim server/services.ls # add a service here
  

Environment Variables

• NODE_ENV -- development, production or test
• NODE_PORT -- port to listen on

References

• Gulp -- http://gulpjs.com
• LiveScript -- http://livescript.net
  • Prelude.ls -- http://preludels.com
• Koa -- http://koajs.com
• React -- http://facebook.github.io/react/docs/getting-started.html
• Primus -- https://github.com/primus/primus
  • Engine.io -- https://github.com/Automattic/engine.io
• PM2 -- https://github.com/Unitech/pm2

Contributors

According to GitHub

Become a Contributor!

TODO

• Famo.us
• Selenium tests
• Wire up react + react router
• Coverage working with LiveScript
• Websockets + feathers-like services
• Implement TODO example app inside skeleton
• Better WebPack config that correctly exports modules
• Bootstrap data-layer -- bookshelf or https://www.youtube.com/watch?v=41oDDTRWjIQ