# { Topsy }

Front-end boilerplate (think v2 of [headstart][headstart])

![topsy][topsy]

[headstart]: http://github.com/geekjuice/headstart
[topsy]: http://img3.wikia.nocookie.net/__cb20130221141341/bobsburgerpedia/images/a/ae/303_13_05_tk2-0051.jpg

## Requirements
* NodeJS/NPM


## Usage

Install
```sh
npm install -g topsy
```

Initialize project
```sh
topsy init -p new_project # topsy help for more options
```

Generator
```sh
cd new_project && topsy shock
```

Develop
```sh
cd _dev && gulp
```

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


## Examples
* [hackernews](http://geekjuice.github.io/topsyHN)
* [hackernews-react](http://geekjuice.github.io/topsyHNReact)


## 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
- [x] 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