Abusayid693/pod-4.1.2-portfolio

Portfolio for Pod 4.1.2

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)

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

Build on Docker

sudo docker-compose up

Development [Windows Environment]

If you want to test it locally or add some new features and you are using windows as your development environment, run the below commands.

• Install ruby [windows section on this link https://www.ruby-lang.org/en/downloads/]
• Install rails so you can run a server [gem install rails]
• Install bundler [gem install bundler]
• run these 2 commands

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

MacOs

Ruby is often already installed in Mac. You can check the version and if it's installed with:

 ruby-v

You can check bundler with:

bundler-v

If you don't have it, you can install with:

 brew install ruby
 gem install bundler

To run:

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

Setting up environment variables

• The project uses GitHub Personal Access Token to fetch repository details from the GitHub API
• You can generate an access token by following the steps in the given link: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
• Once the token is generated, add a new file with the name .env in the root of the project
• Add the following line to the above created file

GITHUB_ACCESS_TOKEN=your-generated-token

• Or you can set the environment variables via your terminal using the command

export GITHUB_ACCESS_TOKEN=your-generated-token

Arch Linux (Refer to arch wiki)

Arch usually comes pre-installed with ruby.

Check if installed by running ruby -v

If not, install it by running sudo pacman -S ruby

By default in Arch Linux, when running gem, gems are installed per-user (into ~/.local/share/gem/ruby/), instead of system-wide (into /usr/lib/ruby/gems/).

So to access your gems, add the following two lines to one of these files: (.profile, zshenv, bash_profile)

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

Then restart 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