Skip to content

Latest commit

 

History

History
174 lines (115 loc) · 6.42 KB

clone_and_edit.md

File metadata and controls

174 lines (115 loc) · 6.42 KB
Raw

Header

How to Clone and Edit This Portfolio Template

TL;DR

How you can clone my portfolio website, edit it, and host it on GitHub Pages for free.


Table of contents


How to Clone and Edit This Repo

(Back to top)
Using Git

Navigate to the folder you wish to use:

cd Users/me/Desktop

Initialize git:

git init

Clone the repo:

git clone https://github.com/caly-pso/portfolio_website_template.git

OR

Downloading the Zip file
  • Open the repo in your browser
  • Click the green download code button towards the top right
  • Download the repo as a zip
  • Unzip the files and place them in the folder you wish to work with

Making Changes

(Back to top)

Now that you have the files on your local computer, you can open them in a text editor. The file structure should be what you see above.

The first thing you will want to do is to customize the index.html page. This includes a projects section, about section, resume section, and a footer where you can link your GitHub, Twitter, etc.

Step 1: Put in your name

At the top, in the about section, and anywhere else you want to display it.

Step 2: Update the sections

Customize the projects section with images of your own projects and place them in the assets/img/portfolio folder. Update the path names of the images displayed, and link them to your GitHub to display the code.

Add your image to the About section, as well as your city, email, interests, and skills.

Put in your resume. Type out your schooling and experience directly into the HTML, and link a PDF version of your resume to the Download Here button. Currently the PDF example is saved in the assets/img folder, where you can save your own.

Add links to your GitHub, LinkedIn, Medium, Twitter, YouTube, etc. You can find the associated icons on Font Awesome, and add in the link to the i tag class.

Step 3: Update the Isotope filter

In order to sort and filter the projects, I used the plugin Isotope. You can customize these filters to be anything you want. But make sure you change both the filter options under the ul id="portfolio-fltrs" section, and within each portfolio item's div class.

Step 4: Create your own README

Under assets/sampleREADME.md you will find a template README you can fill out, and save to the root of your repository. Any time your repo is visited, it will show up on your main page, giving more info about you and what you want to showcase.

Use GitHub Pages to Host

(Back to top)

Now that you have made the website your own, you can host it for free on GitHub. The simplest way is to:

  1. Make sure you have a GitHub account
  2. Create a new repository with the following selections
    • Repo Name: username.github.io (for example I named mine: caly-pso.github.io). This is what will show up in the URL
    • Check Initialize Repository with a README
    • Select Create repository
  3. Now that the repo is made, in GitHub, select the dropdown Add file and choose Upload files. Now drag and drop the files in your portfolio folder into the browser. Once uploaded, Commit your changes.

OR

Using Git
  1. Make sure you have a GitHub account
  2. Create a new repository with the following selections
    • Repo Name: username.github.io (for example I named mine: caly-pso.github.io). This is what will show up in the URL
    • Check Initialize Repository with a README
    • Select Create repository
  3. Clone the repository you just created:

    git clone https://github.com/username/username.github.io

  4. Open the project's folder:

    cd username.github.io

  5. Add, commit, and push your changes:

    git add --all

    git commit -m "Initial commit"

    git push -u origin main

Checkout Your Site:

After 5-10 minutes your website will be viewable at: https://username.github.io. If it is not there, check your repo's setting to ensure the GitHub Pages source is pointing to the correct branch.


About:

I created this website to improve my own skills and am happy to share it! To see my other projects, check out my GitHub:

(Back to top)