Git Product home page Git Product logo

pod-3.1.0-portfolio's Introduction

Portfolio Template

This is a Jekyll website template designed for Pre Fellowship Fellows. During the Pre Fellowship, you'll build a project

Netlify Status

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: Machine Learning Project
  event: MLH Fellowship Pre Fellowship - Batch 3.5
  date: Fall 2020

Experience example.

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

Education example.

- course: Pre Fellowship Fellow
  institute: MLH Fellowship
  dates: Summer 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: Machine Learning Project
  event: MLH Fellowship Pre Fellowship - Batch 3.5
  date: Summer 2021
  page-name: project

Add contact form email

  1. Create a formspree account here: https://formspree.io/register
  2. A verfication mail will be sent to the registered email id. Complete verification before the following steps.
  3. Click on the new project button and then add new form in the project by providing an appropriate name and a valid email id on which you want to be contacted.
  4. After the form is created, the form's endpoint can be accessed in the Integeration tab. The endpoint would look like : https://formspree.io/f/yadayada
  5. Copy the endpoint url and add it to the form_url in _config.yml file. Example : form_url: "https://formspree.io/f/yadayada"
  6. All the submissions will be visible on the Submissions tab. An email will also be sent by default. If you don't see a submission email, you can switch to the Settings tab and make sure the Email Notifications toggle is on.

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.

Add links to your social medias

Head to _data and fill out either social_media.yml. Here is an example for your reference:

- link: tel:+19876543210
  class: fas fa-phone-square-alt

- link: mailto:[email protected]
  class: fas fa-envelope

- link: https://twitter.com/
  class: fab fa-twitter-square

- link: https://linkedin.com/
  class: fab fa-linkedin

- link: https://github.com/MLH-Fellowship
  class: fab fa-github

Replace the links with your respective social media links in the following order:

  1. Phone Number
  2. Mail
  3. Twitter
  4. LinkedIn
  5. GitHub

Note - Please do not change anything in the class field.

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

pod-3.1.0-portfolio's People

Contributors

adata111 avatar amin-codes avatar eshikashah avatar grace-omotoso avatar ishubham21 avatar nilisha-jais avatar ofilipatrick avatar shweta3047 avatar simran1199 avatar tomarviii88 avatar tushar3099 avatar uttam-singhh avatar wrussell1999 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

pod-3.1.0-portfolio's Issues

Change UI for project details

At the moment when you click on your project, it goes to the project detail page but from a UI perspective, it might look good if we can make the cards clickable where an overlay could pop up with all the information related to the project.
Or, perhaps we can also add an option to switch between these options.

Add google analytics support

  • Add config variable for google analytics tag and add same to the header.html
  • Update the readme to direct how to configure this

Add social media links

At the moment, people can see your awesome work but there's no way for them to get in touch with you and network!
We can add them in the footer with an icon but open to your creativity here, or maybe having multiple options and anyone using this template can pick one or the other.

Add Contact section

Generally, on a portfolio website, we have the option to contact the person directly using the website form.
So, it will be great if we can add that section and perhaps link the form response to the email.

image

It can be something along the line of this.

Add Bio

It would be great to have a bio section in the portfolio, where you all can talk more about who you are, and your programming story.

Add Dark Mode theme toggle

It will be great if we can add a toggle to switch between dark and light mode in the template.

I am thinking of something along the line of this image, maybe around the top right corner.

image

Adding Cursor animation

Currently, the cursor is just an arrow, adding a circle animation to the cursor for better UI.

Adding a preloader

Currently the website does not have a preloader. Team 4(Nilisha, Johnpaul and Eshika) would like to add one.

Improve usability on mobile

At the moment, we have a few screen sizes hardcoded to allow this to work on mobile. It would be good if we could make this more responsive.
image

Add Resume/CV

This portfolio acts very like your resume or CV but doesn't contain it. So maybe we can add a button for people to view/download your resume.

Display Github stats

  • Add a section in the portfolio to display github statistics and Most used languages on github

Add links to the Navbar

Add links to the navbar to navigate to the relevant sections (eg. projects, experience) of the page.
Also, it would be great if we can have an option to choose whether we want to make the navbar sticky or not.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.