My Portfolio

Just change src/portfolio.js to get your personal portfolio. Customize portfolio theme by using your own color scheme globally in the src/_globalColor.scss file. Feel free to use it as-is or personalize it as much as you want.

If you'd like to contribute and make this much better for other users, have a look at issues.

Created something awesome for your fork of the portfolio and want to share it? Feel free to open a pull request.

Table of Contents

• Sections
• Getting Started
• How to Use
• Linking portfolio to GitHub
• Change and Customize
• Deployment
• Technologies Used
• Illustrations

Portfolio Sections

✔️ Summary and About Me
✔️ Skills
✔️ Education
✔️ Work
✔️ Projects (Connected with GitHub)
✔️ Big Projects
✔️ Certifications
✔️ Contacts\

To view a live example, click here.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

You'll need Git and Node.js (which comes with npm) installed on your computer or use Docker.

[email protected] or higher
[email protected] or higher
[email protected] or higher

How To Use

From your command line, clone and run developerFolio:

# Clone this repository
git clone https://github.com/joshuaminja/my_portfolio.git

# Go into the repository
cd my_portfolio

# Setup default environment variables

# For Linux
cp env.example .env
# For Windows
copy env.example .env

# Install dependencies
npm install

# Start a local dev server
npm start

Linking Portfolio to GitHub

Generate a GitHub personal access token following these instructions (make sure you don't select any scope just generate a simple token). If you are using GitHub Actions to deploy your portfolio you can skip this section.

1. Create a file called .env in the root directory of your project (if not done already in section: How To Use)

Note: Configuring environment variables before deploying your portfolio is highly recommended as some components depend on API data.

- my_portfolio
  - node_modules
  - public
  - src
  - .env         <-- create it here
  - env.example  <-- this is the base file
  - .gitignore
  - package-lock.json
  - package.json

2. Inside the .env file, add key REACT_APP_GITHUB_TOKEN and assign your GitHub token like this, also add your username as GITHUB_USERNAME

// .env
REACT_APP_GITHUB_TOKEN = "YOUR GITHUB TOKEN HERE"
GITHUB_USERNAME = "YOUR GITHUB USERNAME"

Set showGithubProfile to true or false to show Contact Profile using GitHub, defaults to false.

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.

Note: Open Source Projects section only show pinned items of your GitHub. If you are seeing something as shown below, follow these instructions.

Change and customize every section according to your need.

Personalize page content in /src/portfolio.js & modify it as per your need. You will also need to modify index.html to change the title and metadata to provide accurate SEO for your personal portfolio.

/* Change this file to get your Personal Porfolio */

const greeting = {
  /* Your Summary And Greeting Section */
  title: "Hi, I'm Joshua",
};

const socialMediaLinks = {
  /* Your Social Media Link */
  github: "https://github.com/joshuaminja",
  linkedin: "https://www.linkedin.com/in/joshuaminja/",
  gmail: "[email protected]",
  facebook: "https://www.facebook.com/joshuaminja",
};


const skillsSection = { .... }

const techStack = { .... }

const workExperience = { .... }

const openSource = { .... }

const bigProjects = { .... }

const achievementSection = { .... }

const blogSection = { .... }

const contactInfo = { .... }

const twitterDetails = { ... }

Using Emojis

For adding emoji 😃 into the texts in portfolio.js, use the emoji() function and pass the text you need as an argument. This would help in keeping emojis compatible across different browsers and platforms.

Deployment

When you are done with the setup, you should host your website online. We highly recommend to read through the Deploying on GitHub Pages docs for React.

Configuring GitHub Actions (Recommended)

First you should enable, GitHub Actions for the repository you use.

The Profile and the Repository information from GitHub is only created at the time of deploy and the site needs to be redeployed if those information needs to be updated. So, a configurable CRON Job is setup which deploys your site every week, so that once you update your profile on GitHub it is shown on your portfolio. You can also trigger it manually using workflow_dispatch event, see this guide on how to do that.

• When you are done with the configuration, we highly recommend to read through the GitHub Actions Configuring a workflow docs.

Deploying to GitHub Pages

This section guides you to deploy your portfolio on GitHub pages.

• Navigate to package.json and enter your domain name instead of https://joshuaminja.ml/ in homepage variable. For example, if you want your site to be https://<your-username>.github.io/my_portfolio, add the same to the homepage section of package.json.

• In short you can also add /my_portfolio to package.json as both are exactly same. Upon doing so, you tell create-react-app to add the path assets accordingly.

• Optionally, configure the domain. You can configure a custom domain with GitHub Pages by adding a CNAME file to the public/ folder.

• Follow through the guide to setup GitHub pages from the official CRA docs here.

Technologies Used

• React
• graphql
• apollo-boost
• react-twitter-embed
• react-easy-emoji
• react-headroom
• color-thief

Illustrations

• UnDraw