11 KiB
👔 Portfolio thingy, built with Gatsby.
🎉 Features
The whole portfolio is a React-based single page app built with Gatsby v3.
Most metadata is powered by one resume.json file based on 🗂 JSON Resume, and one projects.yml file to define the displayed projects.
💍 One data file to rule all pages
All displayed project content is powered by one YAML file where all the portfolio's projects are defined. The project description itself is transformed from Markdown written inside the YAML file into HTML on build time.
Gatsby automatically creates pages from each item in that file utilizing the {ProjectsYaml.slug}.jsx template.
🗂 JSON Resume
Most site metadata and social profiles are defined in content/resume.json based on the JSON Resume standard and used throughout the site as a custom React hook. Additionally, a resume page is created under /resume.
If you want to know how, have a look at the respective components:
🐱 GitHub repositories
The open source section at the bottom of the front page shows selected GitHub repositories, sourced from GitHub.
On build time, all my public repositories are fetched from GitHub, then filtered against the ones defined in content/repos.yml, sorted by the last push date, and provided via the pageContext of the front page.
If you want to know how, have a look at the respective components:
📍 Location
On client-side, my current and, if known, my next physical location on a city level is fetched from my (private) nomadlist.com profile and displayed in the header.
Fetching is split up into a serverless function, a hook, and display component. Fetching is done with a serverless function as to not expose the whole profile response into the browser.
If you want to know how, have a look at the respective components:
💅 Theme switcher
Includes a theme switcher which allows user to toggle between a light and a dark theme. Switching between them also happens automatically based on user's system preferences.
If you want to know how, have a look at the respective components:
🏆 SEO component
Includes a SEO component which automatically switches all required meta tags for search engines, Twitter Cards, and Facebook OpenGraph tags based on the browsed route/page.
If you want to know how, have a look at the respective component:
📇 Client-side vCard creation
The Add to addressbook link in the footer automatically creates a downloadable vCard file on the client-side, based on data defined in content/meta.yml.
If you want to know how, have a look at the respective component:
💫 Page transitions
Includes mechanism for transitioning between route changes with full page transitions defined with Framer Motion.
If you want to know how, have a look at the respective components:
📈 Matomo (formerly Piwik) analytics tracking
Site sends usage statistics to my own Matomo installation. To make this work in Gatsby, I created and open sourced a plugin, gatsby-plugin-matomo, which is in use on this site.
🖼 Project images
All project images live under content/images and are automatically attached to each project based on the inclusion of the project's slug in their filenames.
All project images make use of the excellent gatsby-plugin-image plugin, working in tandem with gatsby-plugin-sharp and gatsby-transformer-sharp.
All together, Gatsby automatically generates all required image sizes for delivering responsible, responsive images to visitors, including lazy loading of all images. Also includes the intersection-observer polyfill to make lazy loading work properly in Safari.
All project images use one single component where one main GraphQL query fragment is defined, which then gets used throughout other GraphQL queries.
💎 Importing SVG assets
All SVG assets under src/images/ will be converted to React components with the help of gatsby-plugin-svgr. Makes use of SVGR so SVG assets can be imported like so:
import { ReactComponent as Logo } from './components/svg/Logo'
return <Logo />
🍬 Typekit component
Includes a component for adding the Typekit snippet.
If you want to know how, have a look at the respective component:
✨ Development
You can simply use Docker & Docker Compose or install and run dependencies on your local system.
git clone git@github.com:kremalicious/portfolio.git
cd portfolio/
# GATSBY_GITHUB_TOKEN is required for some parts
# See https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
cp .env.sample .env
vi .env
# use Docker
docker-compose up
# or go with local system
npm i
npm start
🔮 Linting
ESlint, Prettier, and Stylelint are setup for all linting purposes:
npm run lint
To automatically format all code files:
npm run format
npm run format:css
👩🔬 Testing
Test suite is setup with Jest and react-testing-library.
To run all tests, including all linting tests:
npm test
Most test files live beside the respective component. Testing setup, fixtures, and mocks can be found in the ./tests/ folder.
🎈 Add a new project
To add a new project, run the following command. This adds a new item to the top of the projects.yml file, creating the title & slug from the argument:
npm run new -- "Hello"
Then continue modifying the new entry in content/projects.yml.
Finally, add as many images as needed with the file name format and put into content/images/:
SLUG-01.png
SLUG-02.png
SLUG-03.png
...
🚚 Deployment
Every branch or Pull Request is automatically deployed by Vercel with their GitHub integration, where the main branch is automatically aliased to matthiaskretschmann.com. A link to a preview deployment will appear under each Pull Request.
A backup deployment is also happening to a S3 bucket, triggered by pushes to main and executed via GitHub Actions. The deploy command simply calls the scripts/deploy-s3.sh script, syncing the contents of the public/ folder to S3:
npm run deploy:s3
Upon live deployment, deploy script also pings search engines. GitHub requires the following environment variables to be setup for successful deployments in the repository secrets:
AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEYAWS_DEFAULT_REGION
🏛 Licenses
© Copyright 2019 Matthias Kretschmann
All images and projects are plain ol' copyright, most displayed projects are subject to the copyright of their respective owners.
Don't care if you fork & play with it, but you're not allowed to publish anything from it as a whole without my written permission. Also please be aware, the combination of typography, colors & layout makes up my brand identity. So please don't just clone everything, but rather do a remix!
All the rest, like all code and documentation, is under:
The MIT License