Skip to content

Commit

Permalink
Readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Todd Larsen committed Feb 13, 2012
1 parent 11d73c5 commit c1fb2b4
Showing 1 changed file with 35 additions and 30 deletions.
65 changes: 35 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,62 @@

#### Build Small Footprint Clients to Connect with APIs

This project was inspired by the goal of creating the smallest client deployment possible. Known as Single Page Applications (SPA), they are typically characterized by just a single page load JavScript client with a remote backend API.

## Development
Everything in app/src gets bundled up into just 1 HTML file, 1 JavaScript file, 1 CSS file, and 1 image sprite. I use various Node.js modules to keep the entire dev stack in a single programming language.

This is still under development but there's a lot here you can use as
is.
### TODO:
* expand on example zombie testing task
* image spriting task
* ssh deployment task

## What's included

### Development
* CoffeeScript & Stylus compilation
* File watcher/compiler

## Testing
### Testing
* linter
* unit tests
* headless browser with zombie

## Building
### Building
* minification & concatenation
* dependency management
* image spriting

## Documentation
### Documentation
* docco


### Install
## Install
1. Clone Cakefile, linter.json, package.json, and server.coffee into the directory structure below
2. npm install
3. npm install -g coffee-script


### Use
## Use
Run ```cake``` to see available tasks. ```cake start``` will get you up and running for development.


### Directory Structure
--project
--|--Cakefile
--|--package.json
--|--linter.json
--|--server.coffee
--|--app/
-----|--public
-----|--spec
-----|--src
--------|--images
--------|--javascripts
--------|--stylesheets
--------|--coffeescripts
-----------|--controllers
-----------|--collections
-----------|--models
-----------|--views


### TODO:
* zombie testing task
* image spriting task
* write unit tests
* deployment task
--project
--|--Cakefile
--|--package.json
--|--linter.json
--|--server.coffee
--|--app/
-----|--public
-----|--spec
-----|--src
--------|--images
--------|--javascripts
--------|--stylesheets
--------|--coffeescripts
-----------|--controllers
-----------|--collections
-----------|--models
-----------|--views

0 comments on commit c1fb2b4

Please sign in to comment.