Portfolio Template

This is a Jekyll website template designed for Prep Fellows.

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)

Project Setup and Installations

Ruby and bundler installation.

• Follow the steps below to set up Ruby on your local machine depending on the Operating System you are using. Or you can skip if you have Ruby and Bundler already installed in your machine.

Linux

1. Open the terminal and run following commands one after another:

   sudo apt-get update 

2. Install Ruby by running

   sudo apt-get install ruby ruby-dev

3. Set up the bundler by using this command

   sudo gem install bundler

4. Install Dependencies by running

   bundle install --path vendor/bundle

5. Then start the server by running

   bundle exec jekyll serve

   MacOS

1. Open the terminal and run following commands one after another:

   brew install ruby

   ruby --version 

make sure you have ruby 3.2.1 installed, then

gem install bundler

check bundler version

bundler --version   

make sure you have atleast Bundler version 2.4.7

(Optional??)

bundle update --bundler

bundle install --path vendor/bundle

bundle update --verbose 

(as per GitHub comment here - https://github.com/rubygems/rubygems/issues/5234#issuecomment-1242716697)

bundle exec jekyll serve --trace

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

Development

If you want to test it locally or add some new features, run the below commands. Make sure to have Ruby and Bundler installed.

bundle install --path vendor/bundle
bundle exec jekyll serve

Include your details!

Go to fellows folder -> navigate to your_name.md file and include your details as per the template below:

title: (your-name)'s Profile
full_name: #insert your full name
layout: fellow #do not override this
img: #Insert link of your github profile image link
location: #state, country Eg. California, USA
email: # insert your email which you used at MLH
linkedin: https://www.linkedin.com/in/your_linkedin_username
twitter: https://twitter.com/your_twitter_username
github: https://github.com/your_github_username
description: #Please include your short bio!
university: # insert your university name if you're a current student or if you're graduated, then insert your recent university 
interests: #Please include your interests out of tech.
favorite_programming_language: # Please include your favorite programming language

make sure your_name matches the page field in fellows.yml file in _data folder

If you have any ambiguity, refer to the fellows folder and take a look at the already existing .md files and complete your .md file.