Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.69 KB

README.md

File metadata and controls

43 lines (25 loc) · 1.69 KB

BladeRunnerJS (BRJS)

Divide & conquer complex web apps

Getting Started

The best way to get started depends on why you're here.

Documentation

The main documentation for BRJS can be found via http://bladerunnerjs.org/docs. The source code for the documentation can be found via https://github.com/BladeRunnerJS/brjs-site so if you find any error or have any suggestions please submit a pull request.

API reference guides are coming soon.

BRJS Core Toolkit Development

If you are interested in contributing to the BRJS core toolkit then the following information is of use.

How to build BRJS

Get the code

git clone [email protected]:BladeRunnerJS/brjs.git
cd brjs
git submodule init
git submodule update

Build a Distributable Zip

From the root brjs source directory:

$ ./gradlew cutlass-sdk:distZip

The built zip file will be found in BRJS_ROOT/cutlass-sdk/build/distributions/ in the format BladeRunner-VERSION.zip.

More information

See the BRJS Developer Setup Guide for more information.