β Technology β 4 min read
If you want to discuss about something, then you can ask on my Discord Server.
β Star us on GitHub β it helps!
To view a live example, click here
react-js
framework of javascript
and that's why we need nodejs
and npm
installed.nodejs
and npm
, try to install versions which are equal or greater than the versions mentioned in badges above.nodejs
and npm
, clone the repository into your local system using below command:1git clone https://github.com/ashutosh1919/masterPortfolio.git
1npm install
npm start
, it will open the website locally on your browser.In this project, there are basically 4 things that you need to change to customize this to anyone else's portfolio: package.json, Personal Information, Github Information and Splash Logo.
Open this file, which is in the main cloned directory, choose any "name" and change "homepage " to https://<your-github-username>.github.io
. Do not forget the https://
, otherwise fonts will not load.
You will find src/portfolio.js
file which contains the complete information about the user. The file looks something like below:
1// Home Page2const greeting = {3 ...4}56// Social Media7const socialMediaLinks = {8 ...9}1011...
You can change the personal information, experience, education, social media, certifications, blog information, contact information etc. in src/portfolio.js
to directly reflect them in portfolio website.
You will find git_data_fetcher.js
file in the main directory of the repository. This file is used to fetch the data (Pull requests, Issues, Organizations, Pinned projects etc.) from your github.
If you open the file, you will see below component at the top of the file. You need to change only that component.
1const openSource = {2 githubConvertedToken: "Your Github Token Here.",3 githubUserName: "Your Github Username Here.",4};
You can get a github token as described here. Give all permissions while generating token. Also add your githubUserName
in the correct field inside git_data_fetcher.js
.
Now, you need to run following command.
Warning: Treat your tokens like passwords and keep them secret. When working with the API, use tokens as environment variables instead of hardcoding them into your programs.
1node git_data_fetcher.js
This will fetch all the data from your github and it will automatically replace my data with yours. Whenever you want to update the github related information on the website you need to run this command.
Note here that if you click my portfolio, you can see animating the logo at the beginning. I have designed that logo in Figma
and then animated it using css.
Therefore, this part of portfolio is not customizable. But don't worry we have a solution to this problem. You have below two alternatives:
If you want to design your own logo, then you can design it using Figma
or Adobe XD
or Adobe Illustrator
or Inkscape
. If you want to animate it, you can refer to ./src/components/Loader
directory which contains js
and css
files which animates the logo.
If you don't want Splash screen or you don't know how to design logo, then this option is for you.
You can open src/portfolio.js
file and at the top of this file you will see settings
component as below:
1// Website related settings2const settings = {3 isSplash: true,4};
isSplash
from true
to false
.npm start
, it will directly open home
rather than animating logo splash
screen../src/components/Loader
and then revert isSplash
to true
in src/portfolio.js
.src/theme.js
file where all available themes are mentioned with respective color codes.export const chosenTheme = blueTheme;
blueTheme
to whatever theme you want to set your website to.chosenTheme
.Run npm start
to check if everything is ok.
<your-github-username>.github.io
. Please don't give it any other name.Option 1:
npm run build
to generate the production build folder.git init
and push the generated code to the master
branch of your new repository. That's it. Done.
You may need to git init
and force push at every new build.Option 2 (will not work with user pages):
npm run deploy
to build and create a branch called gh-pages
. It will push the build
files to that branch.Github Pages
in settings of the repository and select gh-pages
branch.Now, your website is successfully deployed and you can visit it at <your-github-username>.github.io
.
If you are stuck somewhere and want to observe the deployment process in depth, then please watch below video.
This project is licensed under the MIT License - see the LICENSE.md file for details.
If you can help us with these. Please don't hesitate to open an pull request or issue.
Ashutosh Hathidara π» π π¨ π§ π€ |
Daniel Marostica π π¨ |
Dinesh Nadimpalli π» |
Jivthesh M R π |
Jatin Chauhan π» |
Jainam Desai π» π¬ |
Miftaul Mannan π» |
Ashutosh Mishra π» |
Tamojit π |