ringa
v0.4.6
Published
Ringa is an ES6 MVC-inspired library designed to manage your asynchronous code and state as your project scales.
Downloads
124
Readme
Installation
Right now Ringa JS is only used inside React applications, so you will almost always install it alongside the react plugin:
npm install -S ringa
npm install -S react-ringa
Getting Started
Links
Testing
npm run test
- Coverage with Jest (208 unit tests so far and counting)
Development
This project is under heavy active development and while being heavily tested is still considered Alpha.
Documentation
Documentation is built using MKDocs and stored in the docs
folder.
To edit the documentation with live reload, navigate to the folder and do:
mkdocs serve
When done editing, you can build the docs from the root via npm run docs
.
If you are having issues building, note that you must use an older version of MKDocs right now to use the Cinder template we are currently using:
pip install 'mkdocs<0.15.3'
License
MIT License (c) 2017 by Joshua Jung, Thomas Yarnall, and the Ringa Team