Giter VIP home page Giter VIP logo

Software Developer Master Portfolio ๐Ÿ”ฅ

A clean, beautiful, responsive, and 100% customizable portfolio
template for Software Developers!

HitCounts NodeJS NPM Made With React Join Slack Channel For Support code style: prettier
Netlify Status Build Status License Maintenance Website License Price

If you want to discuss about something, you can ask on my Discord Server.

โญ Star us on GitHub โ€” it helps!

Sections ๐Ÿ“š

โœ”๏ธ Summary and About me
โœ”๏ธ Skills
โœ”๏ธ Open Source Projects Connected with Github
โœ”๏ธ Experience
โœ”๏ธ Certifications ๐Ÿ†
โœ”๏ธ Blogs
โœ”๏ธ Education
โœ”๏ธ Contact me

To view a live example, click here

Clone and Use ๐Ÿ“‹

  • The website is completely built on react-js library of javascript and that's why we need nodejs and npm installed
  • While installing nodejs and npm, try to install versions which are equal or greater than the versions mentioned in badges above
  • In case you want to help developing it or simply saving it, you can fork the repository just by clicking the button on the top-right corner of this page
  • After the successful installation of nodejs and npm, clone the repository into your local system using below command:
     git clone https://github.com/ashutosh1919/masterPortfolio.git
    This will clone the whole repository in your system.
  • To download required dependencies to your system, navigate to the directory where the cloned repository resides and execute following command:
    npm install
  • Now the project is ready to use
  • You can check it using npm start, it will open the website locally on your browser.

Customize it to make your own portfolio โœ๏ธ

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.

package.json

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.

Personal Information

You will find src/portfolio.js file which contains the complete information about the user. The file looks something like below:

// Home Page
const greeting = {
    ...
}

// Social Media
const socialMediaLinks = {
    ...
}

...

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.

How to change the icons on homepage under what i do section?

  1. This section pulls data from skills in portfolio.js file.
  2. Visit this website: https://icon-sets.iconify.design/
  3. Search for the skill you are looking to add.
  4. Select the icon of your choice.
  5. Copy the text beside Selected Icon and replace it with fontAwesomeClassName of that particular softwareSkill.

Github Information

You will find git_data_fetcher.mjs 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.

In the project you will see a env.example file, create a new file named .env and copy contents of env.example into it. In that file, you will see the following environment variables

GITHUB_TOKEN = your_token;
GITHUB_USERNAME = your_username;

You can get a github token as described here. Give all permissions while generating token. Add your github username and the token generated in GITHUB_USERNAME and GITHUB_TOKEN variables in the .env file.

Now, you need to run following command. (Make sure you executed npm install before this)

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.

node git_data_fetcher.mjs

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.

Splash Logo

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:
      // Website related settings
      const settings = {
        isSplash: true,
      };
    • Change isSplash from true to false
    • Now, if you see your website using npm start, it will directly open home rather than animating logo splash screen
    • If you design your logo in future, then edit the files in ./src/components/Loader and then revert isSplash to true in src/portfolio.js.

Other

  • You need to change the website title and other descriptions in public/index.html
  • You can define your own favicon in public/icons directory. If you don't have a favicon, you can generate favicons from Favicon Generator and Favicon IO
  • You can also edit your website preview (known as description image). Run your site locally, take a screenshot and replace with public/icons/desc.png. Note that your screenshot should be 1280x640 for better preview.

Choose Theme ๐ŸŒˆ

  • You can take a look at src/theme.js file where all available themes are mentioned with their respective color codes
  • At the bottom of this file you will see the below code:
    • export const chosenTheme = blueTheme;
    • You need to change the name from blueTheme to whatever theme you want to set your website to
    • You can define new theme similarly as other themes and you can assign name of that new defined theme to chosenTheme
  • That's it. You just need to change the theme name and the code will take care of everything else
  • Run npm start to check if everything is ok.

Deployment ๐Ÿ“ฆ

  • Once you are done with your setup and have successfully completed all steps above, you need to put your website online!
  • I highly recommend using Github Pages to achieve this the EASIEST WAY.
  • To deploy your website, you have two options. First you need to create a github repository with the name <your-github-username>.github.io. Please don't give it any other name.
  • Now, you need to generate a production build and deploy the website.

Option 1:

  • Run npm run build to generate the production build folder.
  • Enter the build folder, git init and push the generated code to the master branch of your new repository on github. That's it. It's Done.
  • You may need to git init and force push at every new build.

Option 2 (will not work with user pages):

  • Run npm run deploy to build and create a branch called gh-pages. It will push the build files to that branch.
  • The last step in deploying is to enable 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.

Technologies used ๐Ÿ› ๏ธ

illustrations ๐Ÿฅ

License ๐Ÿ“„

This project is licensed under the MIT License - see the LICENSE.md file for details.

Contributing ๐Ÿ’ก

If you can help us with these. Please don't hesitate to open an pull request or issue.

  • Move to Gatsby
  • Add Podcast Section and Video Section
  • Add tests to automate review.
  • Setup Travis workflow.

Contributors โœจ

Ashutosh Hathidara
Ashutosh Hathidara

๐Ÿ’ป ๐Ÿ“– ๐ŸŽจ ๐Ÿšง ๐Ÿค”
Daniel Marostica
Daniel Marostica

๐Ÿ“– ๐ŸŽจ
Dinesh Nadimpalli
Dinesh Nadimpalli

๐Ÿ’ป
Jivthesh M R
Jivthesh M R

๐Ÿ“–
Jatin Chauhan
Jatin Chauhan

๐Ÿ’ป
Jainam Desai
Jainam Desai

๐Ÿ’ป ๐Ÿ’ฌ
Miftaul Mannan
Miftaul Mannan

๐Ÿ’ป
Ashutosh Mishra
Ashutosh Mishra

๐Ÿ’ป
Tamojit
Tamojit

๐Ÿ“– ๐Ÿ’ป ๐ŸŽจ
Prabin Karki
Prabin Karki

๐Ÿ’ป
Praveen Kumar Purushothaman
Praveen Kumar Purushothaman

๐Ÿ“–
paul
paul

๐Ÿ’ป
Sandip Dhang
Sandip Dhang

๐Ÿ’ป
Jawad Moustadif
Jawad Moustadif

๐Ÿ’ป
Priyansh Khandelwal
Priyansh Khandelwal

๐Ÿ’ป ๐ŸŽจ
Abdessalam Bahafid
Abdessalam Bahafid

๐Ÿ’ป
Dhruv Krishna Vaid
Dhruv Krishna Vaid

๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿ’ฌ
KasRoudra
KasRoudra

๐Ÿ’ป
Albert Einstein
Albert Einstein

๐Ÿ“–
Suraj Pratap
Suraj Pratap

๐Ÿ“–
Sai Teja
Sai Teja

๐Ÿ’ป ๐Ÿ“– ๐Ÿšง ๐Ÿค”
Anirudh Panda
Anirudh Panda

๐Ÿ’ป
Md Hidayat Rasool
Md Hidayat Rasool

๐Ÿ“–
Siddhant Sadangi
Siddhant Sadangi

๐Ÿ“–
Anoop V
Anoop V

๐Ÿ’ป
Aakash Singh
Aakash Singh

๐Ÿ’ป

References ๐Ÿ‘๐Ÿป

Teoh Sin Yee's Projects

awesome-datascience icon awesome-datascience

:memo: An awesome Data Science repository to learn and apply for real world problems.

flask-emotion icon flask-emotion

Web game to detect face expression using Azure API & built with Flask.

masterportfolio icon masterportfolio

๐Ÿ”ฅ The Complete Customizable Software Developer Portfolio Template which lets you showcase your work and provides each and every detail about you as Software Developer.

ml-nlp icon ml-nlp

ๆญค้กน็›ฎๆ˜ฏๆœบๅ™จๅญฆไน (Machine Learning)ใ€ๆทฑๅบฆๅญฆไน (Deep Learning)ใ€NLP้ข่ฏ•ไธญๅธธ่€ƒๅˆฐ็š„็Ÿฅ่ฏ†็‚นๅ’Œไปฃ็ ๅฎž็Žฐ๏ผŒไนŸๆ˜ฏไฝœไธบไธ€ไธช็ฎ—ๆณ•ๅทฅ็จ‹ๅธˆๅฟ…ไผš็š„็†่ฎบๅŸบ็ก€็Ÿฅ่ฏ†ใ€‚

myhashnode-backup icon myhashnode-backup

backup all articles that I published on https://christeohsinyee.hashnode.dev/

nlp-progress icon nlp-progress

Repository to track the progress in Natural Language Processing (NLP), including the datasets and the current state-of-the-art for the most common NLP tasks.

nlp_projects icon nlp_projects

Store all NLP projects that addressing all basic aspects in NLP.

owasp-pentest icon owasp-pentest

A group project that assesses and identify risks of existing system

python-face icon python-face

Simple Python code to detect human face using Azure Face API

pytorch-textcnn icon pytorch-textcnn

Pytorch implementation of the paper Convolutional Neural Networks for Sentence Classification

rizqi-sdgs-solution icon rizqi-sdgs-solution

โ€œRizqiโ€ is a Web App for the Universiti Sains Malaysia's community that plays an important role in collecting and distributing surplus food and non-food for the needy, provided that the food that is going to be distributed is still edible. This could be food thatโ€™s nearing its sell-by date in mini marts, meals from cafeterias, redundant food from events, groceries that people do not need or secondhand items. Even though this application is on a small scale and is designed only for USM, it would still help reduce the waste generated in Malaysia. The main goal of this system is to ensure every single USMians has enough food to eat and reduce the waste of surplus food and non-food as Malaysia does not have a proper food waste management system.

theodorusclarence.com icon theodorusclarence.com

๐Ÿ’  Personal website and blog made using Next.js, TypeScript, Tailwind CSS, MDX Bundler, and Prisma with PostgreSQL

web_scraper icon web_scraper

Scrap academic staffs' profile of School of Computer Sciences, Universiti Sains Malaysia using BeautifulSoup

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.