Skip to content

Commit 7afd5c4

Browse files
authored
feat: update README.md for github pages
1 parent eae61f7 commit 7afd5c4

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,15 @@ The React Sample App can be easily deployed to [GitHub Pages](#github-pages), or
8383

8484
### GitHub Pages
8585

86-
1. Create a repo on [GitHub](https://github.com).
86+
1. Clone this repo and configure the `authEndpoint`.
8787

88-
1. Add the remote to your project:
88+
1. Create a new repo on [GitHub](https://github.com).
8989

90-
`$ git remote add origin GITHUB_URL/GITHUB_USERNAME/GITHUB_REPO_NAME.git`
90+
1. Add the remote to your project:
9191

92-
1. Open the `package.json` file and on line 5 replace the homepage value `""` with your GitHub repo name with a slash in front like this: `"/GITHUB_REPO_NAME"`.
92+
`$ git remote add myorigin GITHUB_URL/GITHUB_USERNAME/GITHUB_REPO_NAME.git`
9393

94-
1. Open the `vite.config.ts` file and add `base: "/GITHUB_REPO_NAME/"` in `defineConfig` helper.
94+
1. Open the `vite.config.ts` file and add `base: "/GITHUB_REPO_NAME/"` in the `defineConfig` helper.
9595

9696
1. Build your project:
9797

@@ -105,9 +105,9 @@ The React Sample App can be easily deployed to [GitHub Pages](#github-pages), or
105105

106106
`$ git commit -m "deploying to github"`
107107

108-
`$ git push origin master`
108+
`$ git push myorigin main`
109109

110-
1. On GitHub, in your repo, navigate to the "settings" page, scroll down to the "GitHub Pages" section, and choose the "master branch/docs folder" for the source.
110+
1. On GitHub, in your repo, navigate to the "settings" page, scroll down to the "GitHub Pages" section, and choose the "main" branch and "/docs" folder for the source.
111111

112112
1. Now your project will be deployed to https://GITHUB_USERNAME.github.io/GITHUB_REPO_NAME.
113113

0 commit comments

Comments
 (0)