/pod-4.1.0-portfolio

Portfolio for Pod 4.1.0

Primary LanguageHTMLMIT LicenseMIT

Portfolio Template

This is a Jekyll website template designed for Prep Fellows.

Netlify Status

Repo Stats

GitHub code size in bytes GitHub last commit GitHub stars
GitHub forks Languages Issues Watchers

Make your own!

  1. Use the Template button.
  2. Update _config.yml to contain your information.
    1. Change url to the URL you'll be hosting it at
    2. Make sure it has the /
  3. Use something like Netlify or GitHub Pages to deploy (note, this only works on username.github.io, not username.github.io/repo-name)

Add your portfolio

Head to _data and fill out either projects.yml, experience.yml and education.yml.

Project example.

- title: Online Shopping Application
  event: MLH Prep - Batch 4.5
  date: Fall 2021

Experience example.

- role: MLH Prep Fellow
  company: MLH Fellowship
  dates: Summer 2021
  logo: fellowship.svg

Education example.

- course: Prep Fellow
  institute: MLH Fellowship
  dates: Fall 2021
  logo: fellowship.svg

Add project posts

  1. Make a new .md file inside of projects.
  2. Add the header to your markdown file (see below) and change the title to the name of your blog post.
  3. Write your project page! Can be a README from GitHub or your Devpost page.
  4. Add the page-name field to your projects.yml (see below).

Top of post markdown file post.

---
title: Project
layout: page
---

projects.yml with the page-name field.

- title: Online Shopping Application
  event: MLH Prep - Batch 4.5
  date: Summer 2021
  page-name: project

Features and Interfaces

Languages and Tools:

git html5 javascript jekyll ruby sass

Development Instructions

MacOs

Check if ruby is already installed

 ruby-v

You can check bundler with:

bundler-v

If you don't have ruby and bundler, you can install with:

 brew install ruby
 gem install bundler

Then run these commands to set up this project:

 bundle config set --local path 'vendor/bundle'
 bundle exec jekyll serve

Arch Based Distrubutions

Check if ruby is already installed by running

ruby -v

If not, install it by running

sudo pacman -S ruby
export GEM_HOME="$(ruby -e 'puts Gem.user_dir')"
export PATH="$PATH:$GEM_HOME/bin"

Then restart ypur device or run

source ~/.profile

Install bundler by running

gem install bundler

Change directory to project home and setup environment by running

bundle install --path vendor/bundle

Finally start your local dev server

bundle exec jekyll serve --livereload

Windows

Download the executable from the offical page of ruby and after that run these commands in the root directory of the project

bundle install --path vendor/bundle

bundle exec jekyll serve

If you have ruby and jekyll already installed then run these commands to run the server locally

git clone https://github.com/MLH-Fellowship/pod-4.1.0-portfolio 

cd ./pod-4.1.0-portfolio

bundle install --path vendor/bundle

bundle exec jekyll serve

Deployment

Add Google Analytics

  1. Create a Google account if you don't have one

  2. Sign in to your Analytics account

  3. Click Admin

  4. Select an account from the menu in the ACCOUNT column.

  5. Select a property from the menu in the PROPERTY column.

  6. Under PROPERTY, click Tracking Info -> Tracking Code. Your Tracking ID will be displayed at the top of the page

  7. Inside _config.yml file, simply enter your tracking id under google-analytics field.

If you get stuck in any of these steps, refer here.

Need help?

Feel free to ask in the Disussions


if (youEnjoyed) {
    starThisRepository();
}