search

gitname / react-gh-pages

Deploying a React App (created using create-react-app) to GitHub Pages
6.6k stars 922 forks source link

Update README with BrowserRouter instructions #132

Open sdankel opened 1 year ago

sdankel commented 1 year ago

Closes https://github.com/gitname/react-gh-pages/issues/104

sdankel commented 1 year ago

@gitname Thanks so much for creating this repo, it was very easy to follow! This was the only snag I ran into following the README.

gitname commented 1 year ago

Hi @sdankel, thanks for taking the time to write the instructions out so clearly!

I'm hesitant to add steps to the main tutorial that involve an app that is more complex than the one generated by create-react-app (e.g. an app that has React Router installed). I'm trying to keep the main tutorial focused on that bare-bones create-react-app-generated app.

However, I do want to address routing somehow, since many people have expressed confusion about it in Issues. At this point, my tentative plan is to add a "Footnotes" (actual name is TBD) section below the main tutorial, where I address some common situations, including client-side routing using React Router (the other one that comes to mind is the use of a custom domain). Then, in the main tutorial, whenever a footnote would come into play, I would add a reference to that footnote. That is basically what I am envisioning at this point.

Anyway, the instructions you have written are directly applicable to that. I just may move them to a different place in the document (than among the main steps).

I don't have the bandwidth to context switch to this repo this week, but I will add this to my TODO list.

In case I forget to ask later: Once I add something about client-side routing to the tutorial, are you OK with me adding your avatar to the "Contributors" section at the bottom of the README?

https://github.com/gitname/react-gh-pages#contributors

sdankel commented 1 year ago

Anyway, the instructions you have written are directly applicable to that. I just may move them to a different place in the document (than among the main steps).

This sounds like a good plan. Feel free to merge this or hold off until you're ready to reformat the README.

In case I forget to ask later: Once I add something about client-side routing to the tutorial, are you OK with me adding your avatar to the "Contributors" section at the bottom of the README?

Fine by me 😄

sdankel commented 1 year ago

@esemedev are you able to merge this?