Skip to content

akshaykurhekar/Deploy_React_WebApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Steps To Host React Web App on GitHub.

First Step.

Create New Repository as Public repo

Second Step.

Install the gh-pages package as a "dev-dependency" of the app.

$ cd react-gh-pages
$ npm install gh-pages --save-dev
             OR
$ yarn add gh-pages 

Third Step

The commands shown in the following steps can all be issued from within the app's folder. Add some properties to the app's package.json file.

At the top level, add a homepage property. Define its value to be the string http://{username}.github.io/{repo-name}, where {username} is your GitHub username, and {repo-name} is the name of the GitHub repository you created in step

  1. Since my GitHub username is gitname and the name of my GitHub repository is react-gh-pages, I added the following property:
//...
"name": "Project Name",
"homepage": "http://User-gitname.github.io/Repository-Name",
"version": "0.1.0...",

In the existing scripts property, add a predeploy property and a deploy property, each having the values shown below:

"scripts": {
   //...
   "predeploy": "npm run build",
   "deploy": "gh-pages -d build"
  }

Fourth Step

Create a git repository in the app's folder. (1 minute)

$ git init

Initialized empty Git repository in C:/path/to/react-gh-pages/.git/ Add the GitHub repository as a "remote" in your local git repository. (1 minute)

$ git remote add origin https://github.com/gitname/react-gh-pages.git

This will make it so the gh-pages package knows where you want it to deploy your app in step 7. It will also make it so git knows where you want it to push your source code (i.e. the commits on your master branch) in step 8. Generate a production build of your app, and deploy it to GitHub Pages. (2 minutes)

$ npm run deploy
    OR
$ yarn deploy    

That's it! Your app is now accessible at the URL you specified in step 4. In my case, my app is now accessible at: https://gitname.github.io/react-gh-pages/ I recommend exploring the GitHub repository at this point. When I explored it, I noticed that, although a master branch did not exist, a gh-pages branch did exist. I noticed the latter contained the built app code, as opposed to the app's source code. Optionally, commit your source code to the "master" branch and push your commit to GitHub. (1 minute)

$ git add .
$ git commit -m "Create a React app and publish it to GitHub Pages"
$ git push origin master

I recommend exploring the GitHub repository once again at this point. When I did that, I noticed that a master branch now existed, and it contained the app's source code. So, the master branch held the source code, and the gh-pages branch held the built app code.

Last Step

check link of your hosted repo on your terminal / cmd

                  OR                      

github -> repo_name -> settings -> GitHub Pages

you will get hosted link there..

💫 Happy Hosting ✨

About

build React Web App and Deploy on github.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published