Skip to content
This repository has been archived by the owner on Oct 26, 2021. It is now read-only.

staltz/rxmarbles

Repository files navigation

RxMarbles

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

Example switchMap

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

This is a Cycle.js app. Use this as an example implementation of advanced custom elements in Cycle.

Contributing

Unfortunately I do not have time to maintain this project (I have hundreds of other repos to maintain), but I don't want this project to be changed, I think it's very valuable to keep the same features online at rxmarbles.com, which I still regularly pay the domain for. I am sorry for people who would like to update this repo. I advise to build other tools and enrichen the RxJS ecosystem overall. RxMarbles is fine as it is.

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 using npm scripts. To develop, build the project with npm run build.

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

Make a pull request when you're ready.