Skip to content

ringa-js/ringa

Repository files navigation

  • ringa
  • react-ringa
  • ringa-fw-react

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

About

Ringa is a highly extensible ES6 MVC-inspired library designed to help you build scalable and highly debuggable applications.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published