kwand-stack/src/client/README.md

Koa + WebSockets + Angular + Node + Dokku

assets
======

For everything else that isn't a direct part of the site but linked or
embedded. Nothing in assets is processed in any way, just copied over.

* `images` - linked rather than included, high-rez, etc.
* `graphics` - includes original `ai` and `psd` and such
* `media` - video and sound and embedded stuff
* `docs` - pdfs, .mobi, etc.

This a good place to put source assets that have been used to make the
site or app and that are semi-public even if not directly linked. If
your app server does not allow directory browsing (as most do not by
default) you can pick names only you know and communicate directly by
URL to allow some of level of privacy (but not really security).

html
====

The base HTML, Jade templates, markdown and such. Any change to these
files will trigger a reload of `locals.js` and the static templates
are remade.

images
======

Everything in here gets optomized when compiled. Unlike `assets` this
stuff makes up the site instead of just being linked from it for downloads
or not linked at all. 

scripts
=======

Script organization works for single-page apps (SPAs) or more. Scripts
live in `src/scripts` generally at the top level. Only the versions used
in the app get written (not all the unminified stuff as well). Everything
gets `jslint`ed and `uglified`.

Two special subdirectories, `before` and `after`, will be combined into
`client/scripts/before.min.js` and `client/scripts/after.min.js`. When
working with Angular, all the model, view, controller stuff can be
organized in such a way that only a single `.js` request is needed to
load it (unlike bower, jQuery plugins and the like).

The `pkgs` directory can be used to break out components --- particularly
for multi-page apps. One `DIRNAME.pkg.min.js` file is created for each
package from `src/scripts/pkgs/*`. If you just need one main before and
after you don't need the `pkgs` subdirectories.