topsy v1.0.0

{ Topsy }

Front-end boilerplate (think v2 of headstart)

Requirements

• NodeJS/NPM

Usage

Install

npm install -g topsy

Initialize project

topsy init -p new_project # topsy help for more options

Generator

cd new_project && topsy shock

Develop

cd _dev && gulp

Then visit http://localhost:7000 to see the example app running and ready for development.

Examples

• hackernews
• hackernews-react

Components

• RequireJS
• Zepto.js
• Lodash.Underscore
• Backbone
• BrowserSync
• React

Directory structure

  Topsy
  |____ topsy.json (Generator configs)
  |
  |____ _dev (Development Directory)
  |     |____ _src
  |     |     |____backend
  |     |     |____frontend
  |     |     |____test
  |     |     |____vendor
  |     .
  |     .
  |     |____ gulpfile.coffee
  |     |____ package.json
  |
  |____ _static (Deployable Project)
        |____ css
        |____ js
        |____ index.html

TODO

• Consider Browser-Sync in place of Livereload
• Better CLI control and options
• Use better file copier for examples (to prevent entire project copies)
• Join topsy and turvy

Copyright

Copyright © 2014 Nicholas Hwang