loading...

Bootstrap Portfolio w/GitHub Actions

rarean profile image Aaron Perez ・4 min read

Deploy your Bootstrap portfolio to GitHub Pages effortlessly

There are a few different ways of getting started with a website using bootstrap. You could start from scratch, you might have a website that you have put together based on a template, or you can fork an existing site and remake it as your own. However you obtain your site code, you want to publish the site somewhere and have heard about GitHub Pages, but you don’t know how to use GitHub to turn it into a free website.

This tutorial is less focused on the portfolio site code and more on how easy it is to use GitHub Actions to deploy your code to GitHub Pages. For simplicity, I will use an example one page portfolio created with bootstrap and publish to GitHub Pages. If you already have a website ready to go, you can skip to the deployment section.

Getting Started

I will assume you already have the necessary tools installed, and a GitHub account. If you do not have a GitHub account or need to install tools (npm, nodes, and git) please do so before continuing.

  1. Fork the example repository https://github.com/rarean/portfolio-demo. It will take a few seconds to make a full copy of the example “portfolio-demo”.
  2. Go to the Settings tab and rename the repository to USERNAME.github.io, be sure to use your username in place of USERNAME. This username should also match your account name in GitHub.

    • For example, you can see that mine is rarean.github.io and my GitHub username is also rarean
  3. Clone the repo to your computer so that you have a local copy of the code to update with your changes

  4. Open the index.html file and edit the appropriate sections.

<span id="name" class="d-block text-lg"> Your Name </span >
<span id="links" class="text-md">
  <a href="https://github.com/"><i class="fa fa-github mx-2"></i></a>
  <a href="https://www.linkedin.com/"><i class="fa fa-linkedin-square mx-2"></i></a>
  <a href="mailto:your.mail@me.com?Subject=Hello%20again"><i class="fa fa-envelope-square mx-2"></i></a>
</span>
<div id="contact" class="col d-sm-block mx-auto my-auto text-center">
  <a href="https://github.com/" class="badge badge-light mt-5">Projects</a>
  <a href="mailto:your.mail@me.com?Subject=Hello%20again" class="badge badge-light">your.mail@me.com</a>
</div>

5.Verify all your changes are correct and show up as expected before continuing

  • In the root folder of your project, run npm install
  • Once node_modules are installed, run npm start

Deploying Your Portfolio

The magic that creates the site on GitHub Pages is found in the .github/workflows/deploy.yml file. If you have an existing site or code that you want to publish to GitHub pages, you only need to add this file (and it's parent folders) to your project.

name: Build and Deploy
on:
  push:
    branches:
      - master
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          persist-credentials: false

      - name: Install and Build
        run: |
          npm install
          npm run build

      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@releases/v3
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages
          FOLDER: dist

This file tells GitHub Actions to install the project dependencies, run a build script that puts the required files in an output folder named “dist”, and then upload the contents of the “dist” folder to the gh-pages branch. If the branch does not exist, it will create the branch.
The work to deploy the site to GitHub Pages is thanks to JamesIves/github-pages-deploy-action, and you can check GitHub for the different configuration options.

Once you have a portfolio site ready for GitHub Pages, and your project includes the .github/workflows/deploy.yml file, you only need to commit and push your changes to the master branch of your repository. After the GitHub Actions have run, and the gh-pages branch exists, ensure settings are pointing to the correct branch to display your site.

Go to the settings of your repository and ensure that the source for GitHub Pages is using the correct branch. It is close to the bottom of the main settings page.

Note that it may take a few minutes to populate DNS servers for it to show up in your browser; however, once available, you can click the link in green bar that GitHub says your site is available at.

Thats It!
Easy Right!

Posted on by:

Discussion

markdown guide