Step 1: Add homepage to package.json
https://create-react-app.dev/docs/deployment/#step-1-add-homepage-to-packagejson
Step 2: Install gh-pages and add deploy to scripts in package.json
Now, whenever you run npm run build, you will see a cheat sheet with instructions on how to deploy to GitHub Pages.
To publish it at https://myusername.github.io/my-app, run:
npm install --save gh-pages
If you are deploying to a GitHub user page instead of a project page you'll need to make one additional modification:
Tweak your package.json scripts to push deployments to master:
"scripts": {
"predeploy": "npm run build",
- "deploy": "gh-pages -d build",
- "deploy": "gh-pages -b master -d build",
Step 3: Deploy the site by running npm run deploy
Then run:
npm run deploy
Step 4: For a project page, ensure your project’s settings use gh-pages
Finally, make sure GitHub Pages option in your GitHub project settings is set to use the gh-pages branch:
Step 5: Optionally, configure the domain
You can configure a custom domain with GitHub Pages by adding a CNAME file to the public/ folder.
Your CNAME file should look like this:
mywebsite.com