@chakrajs/framework

Modular JavaScript framework for building decentralized apps


Keywords
Cubefuse, Chakra
License
MIT
Install
npm install @chakrajs/framework@0.0.3

Documentation

Chakra Framework

A Cubefuse Project Code Standard Style Compliant Readme Standard Style Compliant Travis CI Codecov Codacy npm

Documentation API Reference

Modular JavaScript framework for building decentralized apps

Table of Contents

Getting Started

npm package

This is the recommended method for using Chakra.

npm install @chakrajs/framework

If you are using yarn (recommended), use this instead.

yarn add @chakrajs/framework

<script> include

Directly include with <script> tag on your html pages. This only works for web browsers. Chakra would be included as a global variable.

  • Download and use

Downloads can be found in the GitHub Releases page.

  • Use from CDN
<!-- Development version -->
<script src="https://unpkg.com/@chakrajs/framework/dist/index.js"></script>

<!-- Minified version -->
<script src="https://unpkg.com/@chakrajs/framework/dist/index.min.js"></script>

Please read the Documentation and the API Reference to start building Chakra Apps.

Development Setup

git clone https://github.com/cubefuse/chakra.git
cd chakra
yarn install
  • The code can be built for both Node.js and the browser by yarn build.
  • To run the tests and generate coverage reports, use yarn test and yarn coverage.
  • Code linting with the JavaScript Standard Style is available with yarn lint.
  • Code documentation can be built with yarn docs.

Maintainers

@mprasanjith

Contribute

We welcome your pull requests and bug reports.

License

MIT © 2018 Cubefuse