boxart/boxart

Name: boxart

Owner: BoxArt

Description: A JavaScript library providing a set of tools for building Games written with DOM and React.

Created: 2016-04-26 19:33:20.0

Updated: 2017-05-24 05:52:27.0

Pushed: 2018-03-20 18:08:32.0

Homepage:

Size: 478

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

boxart Build Status

Tools for building html games with React. Depended on by and documented at boxart/boxart-boiler.

Local Development

To work on boxart locally, you must have Node installed on your computer. After cloning this repository, run npm install (from the command prompt or terminal) to download boxart's package dependencies.

To run the boxart unit test suite, use the npm test command; or (if Grunt is globally installed on your computer) run grunt test-dev.

Development Commands

Note: these test commands assume the Firefox web browser is installed on your development system.

npm run test-dev

npm test-dev boots a test server with Karma to automatically re-run tests in a captured Firefox browser instance whenever changes are made to the source code or tests.

npm test

npm test runs the test suite once in a captured Firefox browser instance and then exits.

grunt babel

grunt babel will run babel to create a lib directory of ES5 code compiled from this repository's ES2016 src directory.

grunt watch

grunt watch (or grunt watch:babel) will automatically re-run grunt babel whenever files in src change; this is useful if you have used npm link to include a local copy of boxart in your application for development purposes.

grunt publish

grunt publish transpiles boxart's es2015 code to es5 and publishes boxart and its subpackages (e.g. boxart-stage) to npm.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.