imanishbarnwal.github.io

Resume and project showcase website

This webisite is inspired by Long Do

Getting Started

To get a local copy up and running follow these simple steps.

The commands and instructions I provide are for MacOS - please look up the specific commands for your OS on your own.

Prerequisites

brew install node

If you need to switch between Node versions regurlarly, I would recommend to install Node via Node Version Manager.

gem install bundler jekyll

For more information, refer to this.

npm install -g yarn

Installation

Recommended way: If you want to contribute to this theme or open issues due to problems implementing this on your own, I would recommend forking the repository directly. This makes it easier for me to solve open issues and questions or check pull requests.

1.1: Fork the repository (using the Fork button at the top) and then clone the repository

# Replace {YOUR_USERNAME} with your actual username
git clone https://github.com/{YOUR_USERNAME}/imanishbarnwal.github.io.git

or

1.2: Create your own repository (using the green Use this template button at the top) and then clone the repository

# Replace {YOUR_USERNAME}, {YOUR_REPOSITORY} with the actual values
git clone https://github.com/{YOUR_USERNAME}/{YOUR_REPOSITORY}.git

2: Change directory into {YOUR_REPOSITORY}

cd {YOUR_REPOSITORY}

3: Install dependencies

yarn

Usage

  • Run and develop locally with live server at http://localhost:4000, this will also build production-ready JS and SCSS assets with every change
gulp
  • After committing and pushing, see the Settings page of your repository to see where your site is published at via Github Pages.

Personalize and Customize

_config.yml

Edit _config.yml to personalize your site. For documentation, refer to docs/config.md.

Github Metadata Plugin

If you want to automatically have your Github repositories pulled for the Open Source Projects section, then you also need to authenticate yourself for the Github Metadata plugin to work.

You need to generate a new personal access token on GitHub:

  • Go to the Github Token site
  • Select the scope public_repository, and add a description.
  • Confirm and save the settings. Copy the token you see on the page.
  • Create a .env file inside your repository and add your generated JEKYLL_GITHUB_TOKEN:
JEKYLL_GITHUB_TOKEN=0YOUR0GENERATED0TOKEN0

To complete the configuration for the Github Metadata plugin, you also need to change the value of repository inside _config.yml. After this, you should the Github Metadata plugin should work properly.

For optimal results, you should make sure, that every Github project, you want included on this portfolio, has added following informations on Github:

  • Description
  • Homepage link, if there is a live version of it
  • Topics

Example: ![Github Repository Information Example][github-repo-info]

_data/*.yml

Edit files inside _data to add information to the portfolio. For documentation, refer to docs/data.md.

Particles.js

Edit assets/particles.json to customize the landing page backgorund animation. For more information, refer to this.

jekyll logo

Want a Jekyll website built?

Hire a Jekyll developer