Hosting React App in GitHub using gh-pages
Did you build React app and want to deploy it, following these simple steps you able to deploy and showing the world your amazing app.
I will show how to create and deploy React App using create-react-app
and GitHub Pages.
Prerequisites :
- GitHub Account.
- Install Git in your machine and Set up Git.
Make sure you have Node.js and Npm installed in your machine.
Notice You’ll need to have Node 8.10.0 or later on your local machine.
Procedure :
1- First create a repository named my-app
using create-react-app
.
npm init react-app my-app
2- We need to install GitHub Pages package as a dev-dependency.
cd my-app
npm install gh-pages --save-dev
3- Add properties to package.json
file.
The first property we need to add at the top level homepage
second we will define this as a string and the value will be "http://{username}.github.io/{repo-name}"
{username} is your GitHub username, and {repo-name} is the name of the GitHub repository you created it will look like this :
"homepage": "https://github.com/koushikch7/react-test/"
Second in the existing scripts
the property we to need to add predeploy
and deploy
.
"scripts": {
//...
"predeploy": "npm run build",
"deploy": "gh-pages -d build"
}
4- Create a Github repository and initialize it and add it as a remote in your local git repository.
Now, create a remote GitHub repository with your app name and go back initialize thisgit init
add it as remotegit remote add origin git@github.com:Yuribenjamin/my-app.git
5- Now deploy it to GitHub Pages.
just run the following command :
npm run deploy
his command will create a branch named gh-pages
this branch host your app, and homepage property you created in package.json
file hold your link for a live preview, or you can open the branch setting scroll down to GitHub Pages section you will find Success Message.
6- commit and push your commit to GitHub. Optionally
git add .
git commit -m "Your awesome message"
git push origin master
That’s it, you have learned to host in the GitHub absolutely free of server cost with you react app using Gh-Pages and GitHub.
write to me contact@chkoushik.com or comment for any further clarification.