Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with BrowserRouter instructions #132

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sdankel
Copy link

@sdankel sdankel commented Jan 23, 2023

Closes #104

@sdankel
Copy link
Author

sdankel commented Jan 23, 2023

@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
Copy link
Owner

gitname commented Jan 24, 2023

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

@gitname gitname self-assigned this Jan 24, 2023
@gitname gitname added enhancement react-router App uses React Router labels Jan 24, 2023
@sdankel
Copy link
Author

sdankel commented Jan 24, 2023

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
Copy link
Author

sdankel commented Jun 5, 2023

@esemedev are you able to merge this?

@Yuskhosmith Yuskhosmith mentioned this pull request Oct 6, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement react-router App uses React Router
Projects
None yet
Development

Successfully merging this pull request may close these issues.

page deployed but paths doesn't work
3 participants