JS Seed

A somewhat opinionated JS Seed/Starter Kit relying on Gulp + Browserify. A lot of this was born out of this blog post. Please refer to it for more info on the libs used for creating this lil slice of JS development heaven.

I mentioned "opinionated" because I like React at the moment and this 'starter kit' builds out a React and Flux-based architure of an app.

It includes the following tools, tasks, and workflows:

Browserify (with browserify-shim)
Watchify (caching version of browserify for super fast rebuilds)
Compass
React (JSX compilation to JS)
- Flux'ish structure
- react-router and some basic routes
jQuery (from npm)
Non common-js vendor code (like a jQuery plugin)
LiveReload
Static Server
Image optimization
Error Notifications in Notification Center
Superagent (from npm) for super clean and lightweight AJAX business
Jest for test running (Jasmine for writing your tests)
Project-based .vimrc (<leader>t runs your tests if you don't have watching for your test-file changes turned on).
Uses Pure CSS and Font Awesome

If you've never used Node or npm before, you'll need to install Node. If you use homebrew, do:

brew install node

Otherwise, you can download and install from here.

Install gulp globally

Gulp must be installed globally in order to use the command line tools. You may need to use sudo

npm install -g gulp

Install compass (if you haven't already)

The gulp-compass module relies on Compass already being installed on your system.

gem install compass --pre

Install npm dependencies

npm install

This runs through all dependencies listed in package.json and downloads them to a node_modules folder in your project directory.

Run gulp

gulp

This will create and run the task defined in gulpfile.js. If you're on OS X, and have Chrome installed, a window will open displaying the demo page. If not, you can visit http://localhost:3002 to view the test page. Browsersync keeps all of your source changes in sync with the browser in a livereload fashion.

Run tests

# NOTE: ensure `gulp` is running already. There is a 22-32s warm up time for
the first test run. There-after the single test included takes 3-4s to run.

gulp test

TODO

add more stubbed out modules for flux/reflux/fluxxor architecture
fix issue with error causing gulp to no longer try and re-reactify stuffs

megalithic / js-seed