https://github.com/ringa-js/ringa

Ringa is a highly extensible ES6 MVC-inspired library designed to help you build scalable and highly debuggable applications.
https://github.com/ringa-js/ringa

async asynchronous-task-trees dom promise react task-tree

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ringa-js/ringa
• Owner: ringa-js
• License: mit
• Created: 2017-01-15T19:58:26.000Z (over 9 years ago)
• Default Branch: develop
• Last Pushed: 2019-02-03T17:25:43.000Z (about 7 years ago)
• Last Synced: 2025-09-23T23:13:11.677Z (7 months ago)
• Topics: async, asynchronous-task-trees, dom, promise, react, task-tree
• Language: JavaScript
• Homepage:
• Size: 5.64 MB
• Stars: 10
• Watchers: 7
• Forks: 0
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[](http://demo.ringajs.com)

* ringa [](http://www.github.com/ringa-js/ringa)

* react-ringa [](http://www.github.com/ringa-js/react-ringa)

* ringa-fw-react [](http://www.github.com/ringa-js/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

* [Hello World Tutorial](http://ringajs.com/gettingStarted/helloWorld/)

* [Blank React Application Template](https://github.com/ringa-js/ringa-app-template)

* [Chuck Norris Joke Loader](https://github.com/ringa-js/ringa-example-chuck-norris)

* [TodoMVC](https://github.com/Saajan/ringa-todomvc)

## Links

* **[Documentation](http://www.ringajs.com)**

* **[Trello-like Demo](http://demo.ringajs.com)**

* **[React Component Demo](http://react.ringajs.com)**

## 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