status-im
/
re-frame-10x
mirror of https://github.com/status-im/re-frame-10x.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

README

This commit is contained in:
Mike Thompson 2018-01-21 11:43:03 +11:00
parent ff7d3b4f0a
commit c527aed09e
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,7 +1,7 @@
# re-frame-trace
`re-frame-trace` is a programmer's dashboard. It helps you to see inside a running `re-frame`
application, allowing you to better understand it and debug it.
application, allowing you to better understand it and debug it.
**Status:** Alpha. [![Clojars Project](https://img.shields.io/clojars/v/day8.re-frame/trace.svg)](https://clojars.org/day8.re-frame/trace)
@ -12,8 +12,8 @@ application, allowing you to better understand it and debug it.
Four ways:
1. It helps you to learn `re-frame`. Simply looking at
the "raw traces" gives you some insight into how it operates. Even experienced
re-framians, er, like me, learned a lot.
the "raw traces" provides insight into how it operates. Even experienced
re-framians, er, like me, have learned a lot.
2. It helps you to explore and learn an unfamiliar `re-frame` codebase.
When I click, over here, on this "X" button, it shows me what event is `dispatch`-ed
and in what namespace the associated event handler is registered. And,
@ -27,7 +27,7 @@ Four ways:
> This list is currently aspirational. `re-frame-trace` remains a WIP. We're getting there.
### Epoch Oriented
### It Is Epoch Oriented
`re-frame` applications are computationally regular. First an event happens,
and then boom, boom, boom go a series of known computational steps (dominoes),
@ -45,34 +45,34 @@ aspect of what `re-frame-trace` delivers.
### It Is All About The Data
As it runs, `re-frame` logs "trace" as data, not strings.
As it runs, `re-frame` logs "trace" as data (not strings).
This data trace provides an x-ray of your app's functioning.
In addition, while re-frame is a functional framework, it is more
strongly defined by its "data oriented" design. `re-frame's` approach is
to "flow" data, in a loop, through the functions you provide.
At any point, to know what happened, you must know what data happened.
To understand what is happening in a `re-frame` app, you must understand
what data is happening.
So, data is at the core of `re-frame-trace` in two ways
and that's a powerful and leverageable substrate.
and that's a delightfully powerful and leverageable substrate.
### Data Dashboard
### It Is A Data Dashboard
Except, there's often too much data - too much detail.
So, `re-frame-trace` tries to be something of a "dashboard" in the sense that
it tries to curate "raw data" into "information" through various kinds of analysis
and "roll ups". The goal is to deliver insight "at a glance", while still allowing
you to drill into the detail.
you to drill down into the detail.
Right. So, in summary, this tool an epoch-oriented, interactive data dashboard for
gaining insights and assisting debugging.
Right. So, we now know enough to give a summary: this tool is an epoch-oriented,
interactive data dashboard for gaining insights and assisting debugging.
But, it is also a work in progress,
so my magnificent descriptions (above) run well ahead of what is delivered right now.
so my enthusiastic descriptions (above) overstate what is delivered right now.
But we're getting there.
## A Visual Sampler
<img src="docs/images/re-frame-trace-demo.gif" height="500px">