Right now, it's pre-alpha. Stay tuned for more.
Setup and Usage
Real documentation is coming later; right now, this really isn't intended for use by anyone other than me.
That being said:
npm installto install dependencies
gulpto compile to a production file suitable for client-side JS consumption (
dist.jsin the root folder)
npm testruns the test suite. It's got decent coverage at a functional, not unit, level.
- If using the reference iOS client,
git submodule update --init
- Put your data files in the
examplesfolder, with any media needed in a subfolder with the same name (e.g.
sample.jsonwould have a folder called
Knock yourself out.
For development, a few gulp scripts exist.
gulp browsercompiles a single
dist.jsfile. This file exposes a
gulp nodecompiles each individual ES6 source file (in
src/) into an equivalent non-ES6 file in
lib/. This is intended for requiring storyboard as a
npmlibrary in node.js
gulp watchis the equivalent of
gulp browser, but listens for live file changes and automatically recompiles.
This project is licensed under the MIT License. See the LICENSE file in this repository for more information.