etinaude / portfolio-workshop

A workshop run by GDSC at the University of Auckland to create basic portfolio websites

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Portfolio Workshop

Portfolio workshop run by Google Student Developer Club at the University of Auckland.

πŸš— Install

Install Node.js and npm.

Install the dependencies:

npm install

πŸ‘Ÿ Run

rename one of the templateX.svelte files in src/routes/ to index.svelte

eg template1.svelte >> index.svelte

Then run:

npm run dev

πŸ›©οΈ Templates

Testing templates

You can test your content in different templates by adding the template number to the end of the url.

eg localhost:3000/template1

Content

All the content for your portfolio is in src/content

The .json files allow you to edit the text eg, your name, your projects, your skills, etc. The theme.scss file lets you to edit the colours and styles of your portfolio. The images folder is where you add images to your portfolio. (linked in the .json files)

All the code is provided so you can also edit the templates to make them your own.πŸ™‚

Template 1

Template 3

Template 2

Template 3

Template 3

Template 3

Template 4

Template 4

πŸš€ Hosting with GitHub Pages

  1. Go to https://github.com/<YOUR USERNAME>/portfolio-workshop/settings/pages.
  2. Under Build and deployment, select Deploy from a branch and the branch should be gh-pages.
  3. Check that your website is deployed at https://<YOUR USERNAME>.github.io/portfolio-workshop!

How it works

Using GitHub Actions, we create an action that automatically runs every time a change is pushed to the main branch. The config file for the action is at .github/workflows/github-pages.yml, and you can see that it has four main steps:

  1. Checkout the git repo.
  2. Install Node & project dependencies.
  3. Build the project.
  4. Deploy to GitHub Pages.

πŸ›₯️ Socials

Developers

Etienne Naude Matt Moran Eugene Chua Hiruna Jayamanne
Portfolio etinaude.dev mattm.nz echua.top hiru.dev
GitHub etinaude DarkMatterMatt luorixo HiruNya

GSDC

Link
Discord W6QtB3Sm2U
Instagram @gdsc.uoa
Website GSDC

About

A workshop run by GDSC at the University of Auckland to create basic portfolio websites

License:GNU General Public License v3.0


Languages

Language:Svelte 78.1%Language:SCSS 12.6%Language:TypeScript 6.4%Language:JavaScript 1.8%Language:HTML 1.1%