search

day8 / re-frame-10x

A debugging dashboard for re-frame. X-ray vision as tooling.
MIT License
636 stars 68 forks source link

Improves documentation for shadow-cljs setup #299

Closed diegovdc closed 3 years ago

diegovdc commented 3 years ago

I was very confused by the current documentation regarding the setup with shadow-cljs. After some time I found the re-frame-template repository which cleared things up quite a bit.

This PR is based on the resulting shadow-cljs.edn produced by this command: lein new re-frame shadow-reframe +10x.

I am quite new to re-frame so I am not sure if re-frame/tracing is a required dependency for this to work. I am also not sure what the following means, but I guess it's useful:

:release {:build-options
                 {:ns-aliases
                    {day8.re-frame.tracing day8.re-frame.tracing-stubs}}}

I hope this will help others like me to figure out an easy way to setup this dependency when using shadow-cljs.

superstructor commented 3 years ago

Thanks for the feedback and PR @diegovdc 👍🏻 😄

This brought to my attention that not only was the 10x documentation inadequate, but the re-frame-template shadow-cljs.edn was using some deprecated configuration as well.

E.g. According to shadow-cljs docs nowadays :preloads should be in :devtools.

I've fixed both re-frame-template as of v2.1.1 and the 10x README.md as shadow-cljs shouldn't be considered 'advanced' anymore, its the most recommended option (vs figwheel, cljsbuild etc) so I've put it on the front page.