reagent-project / reagent

A minimalistic ClojureScript interface to React.js
http://reagent-project.github.io/
MIT License
4.75k stars 415 forks source link

Flesh out the Getting Started instructions in the README #564

Closed mkropat closed 1 year ago

mkropat commented 2 years ago

It is my impression that Reagent is the flagship project for implementing dynamic frontends in the Clojure world. So I was a little disappointed how long it took me to start using the project. I came to the project knowing nothing about the Clojure frontend world, but having some experience with both Clojure and Leinengen, and extensive experience with the JavaScript/React/npm ecosystem. And yet I was really stumped how to use the darn thing. lein run didn't really work. npm start definitely didn't. So then I had to do a deep dive into what figwheel is and what shadow-cljs is and when you would use each. "Before you can run this project you must first understand the entire ecosystem it lives in"—probably not what this project is going for. Anyway, I'm rambling...

Thankfully, I think it's easy to fill in the key details that an impatient, ignorant user like myself needs. I've taken a stab at it here. Not sure if this is actually the best/recommended way to run the project currently—please advise. I tried to be consistent with: https://github.com/reagent-project/reagent/issues/551

One other thought: the project has a beautiful website. The complete Getting Started information should live there IMO (it's the first place I checked), with perhaps an abbreviated version in the README and/or a prominent link to the Getting Started section there. But as a first step I stuck with the existing pattern of putting this information in the README.