Skip to content

PatrickJS/rxmarbles

 
 

Repository files navigation

RxMarbles

A webapp for experimenting with diagrams of Rx Observables, for learning purposes.

Example merge

Features:

  • Visualize example diagrams for each operator in Rx
  • Drag an item ("marble") on an Observable to see how the operator reacts
  • Direct link to any example diagram, e.g., http://rxmarbles.com/#delay

Implementation

The source code is written in CoffeeScript. The architecture is a simple MVC heavily dependent on RxJS. Some parts of the views render to the DOM using pure JavaScript APIs for DOM manipulation, some other parts use virtual-dom for optimizing performance.

Contributing

Fork and git clone the repository.

npm install

The roadmap is entirely specified in the TODO file, which follows the git-done syntax. You can also use git done instead of git commit if you wish. For minor bug fixes, you won't need to deal with the TODO file. But if you're building a feature, remember to write a DONE entry before you commit and send the pull request.

The build system is gulp. To develop, run in watch mode using the default task:

gulp

And access the site on your local machine as file:///path/to/rxmarblesrepo/index.html.

To build the project with no watch mode, run the task gulp dev-build (development) or gulp build (production).

Make a pull request when you're ready.

About

Interactive diagrams of Rx Observables

Resources

License

Stars

Watchers

Forks

Packages

No packages published