This is the code to run a static react-based application as a personal webpage hosted with GitHub Pages.
Project based on the work of Hashir Shoaeb.
In addition to that I have personally added:
- Google Analytics support
- A working blog page
- The images carousel in the home page
- Several different minor/major addition like SEO support and fixing the redirection.
- Building sitemap correctly (
npm run sitemap
) - Email obfuscation
Here I use the master branch as the developement
branch, while the deploy branch is gh-pages
Access the webpage here
You should have Node.js and Git installed on your PC. You should also own a GitHub account.
-
To Get Started, Fork this repository to your GitHub account:
-
Clone the forked repo from your account using:
git clone https://github.com/<your-username>/home.git
-
Open in editor and edit src/editable-stuff/config.js file.
-
Add your resume as <resume.pdf> in place of src/editable-stuff/resume.pdf
-
Edit title and meta description in public/index.html.
-
Change URL in package.json file:
"homepage": "https://<your-username>.github.io/home"
Or for deployment at custom domain, refer create-react-app.dev
-
After editing run the following bash commands:
npm install npm start
-
To deploy website, run:
npm run build npm run deploy
Or for deployment at <username>.github.io, refer READMEdocs/custom-deployment.md and pages.js
-
Congrats your site is up and running. To see it live, visit:
https://<your-username>.github.io/home
-
To change the thumbnail image:
- Navigate to the "public" folder.
- There you will see "social-image.png".
- Delete it.
- Take a screenshot of your version and rename it "social-image.png" and place it there.
Next time if you make changes, repeat from step 8.