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

Edit installation instructions

This commit is contained in:
chris (daiyi) 2017-07-25 15:44:35 +02:00
parent b38e2f43fd
commit 5a44165e2b
1 changed files with 38 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,6 +1,6 @@
# re-frame-trace
A trace window for re-frame
A trace panel for re-frame.
## Motivation
@ -8,24 +8,25 @@ re-frame provides a data driven architecture, but we need to be able to inspect
<img src="docs/images/trace-window.png" height="400px">
## How does it work?
## Installation
re-frame has instrumentation to collect traces throughout various important points in the lifecycle of a re-frame app. re-frame-trace is a consumer of these traces, and provides visualisations of the traces. These traces have a well-defined structure, and will eventually be standardised, allowing other developers to create their own tooling to work against the traces. Currently, re-frame's tracing and re-frame-trace are in alpha and are subject to change at any time.
If you are using leiningen, modify `project.clj` in the following ways. When puzzling over the various possible leiningen configurations, it's often helpful to look at a sample [project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj).
## Getting started
Compile your app with `:closure-defines: "re_frame.trace.trace_enabled_QMARK_" true` and `:preloads [day8.re-frame.trace.preload]`.
So when using leiningen, add the following to `project.clj`:
- `[day8.re-frame/trace "0.1.0"]` in `:profiles :dev :dependencies`
- Add re-frame-trace as a dev dependency by placing `[day8.re-frame/trace "0.1.0"]` within `:profiles :dev :dependencies`. For example:
```cljs
{:profiles
:profiles
{:dev
{:dependencies [day8.re-frame/trace "0.1.0"] }}
{:dependencies [[some-other-package "0.0.0"]
[day8.re-frame/trace "0.1.0"]] }}
```
- `:closure-defines: "re_frame.trace.trace_enabled_QMARK_" true` and `:preloads [day8.re-frame.trace.preload]` in `:compiler`
- Locate the `:compiler` map under `:dev` and add:
- `:closure-defines {"re_frame.trace.trace_enabled_QMARK_" true}`
- `:preloads [day8.re-frame.trace.preload]`
For example:
```cljs
{:builds
@ -36,13 +37,22 @@ So when using leiningen, add the following to `project.clj`:
:preloads [day8.re-frame.trace.preload]}}]}
```
## Usage
- Start up your application.
- Once it is loaded, focus the document window and press `ctrl-h` to slide open the trace panel and enable tracing.
- When the panel is closed, tracing is disabled.
## How does it work?
re-frame has instrumentation to collect traces throughout various important points in the lifecycle of a re-frame app. re-frame-trace is a consumer of these traces, and provides visualisations of the traces. These traces have a well-defined structure, and will eventually be standardised, allowing other developers to create their own tooling to work against the traces. Currently, re-frame's tracing and re-frame-trace are in alpha and are subject to change at any time.
By default, re-frame tracing is compiled out, so it won't impose a performance cost in production. The trade-off here is that you need to explicitly enable it in development.
The [preloads](https://github.com/clojure/clojurescript/wiki/Compiler-Options#preloads) option (`:preloads [day8.re-frame.trace.preload]`) has to be set in order to automatically monkeypatch Reagent to add appropriate lifecycle hooks. Yes this is gross, and yes we will try and make a PR to reagent to add proper hooks, once we know exactly what we need. The preload namespace also injects a div containing the devtools panel into the DOM.
Now you can start up your application. Once it is loaded, press Ctrl+H to slide open the trace panel and enable tracing. When the panel is closed, tracing is disabled.
## Development
### Setting up re-frame-trace for development