Skip to content

my personal website template & first open-source project! please use my template, customize the colors/fonts, & message me for a feature! responsive, mobile-first, accessible & dark-theme. semantic HTML and CSS from scratch with Bootstrap & Sass. toolchain built from my custom open-source template.

License

Notifications You must be signed in to change notification settings

ashlink11/ashlink11-original-personal-site-template

Repository files navigation

Date created: Monday, April 13, 2020

Date last modified: Thursday, June 3, 2021

If you clone this repo, yarn install and yarn start to get started, then go to http://localhost:1234/. For more info on building, check out the build process.

Version History

Version 1 (MVP -- minimum-viable-product) completed April 21, 2020

  • Name, quote, photo.
  • 4 projects
  • Skills section
  • About me section
  • Contact section
  • Mobile-first, responsive, accessible, dark-mode, minimalist design.

Version 2 - completed April 22, 2020

  • "About this site" section on accessibility, licensing, and tech.
  • Alt text and title text on all images. All logos have alt text.
  • Story of development for all Projects.
  • In-class presentation link on Data Flow.
  • Ensures all links open in a new tab.
  • Navigation menu to navigate to parts of the page.
  • Focus on accessibility including h1,h2,h3 hierarchy.

Version 3 - finished April 23, 2020

  • Bill of Tech to README
  • Licensing
  • Vulnerabilities

Version 4 - finished May 8, 2020

  • Rebuilt toolchain from scratch with yarn and parcel
  • Also includes Bootstrap, Sass and gh-pages dependencies
  • Resized images so they are never wider than 450px and 530px accordingly
  • All tech is now MIT-Licensed and able to be used commercially
  • All tech is latest version which helps prevent vulnerabilities

Dark Theme Design

I used the Pantone 2018 Color of the Year "ultra violet" for my primary color (hex: #5f4b8b). Then, I used Material.io's Color Palette Generator to generate my complementary color (sage green-ish).

Color Palette

I chose a handful of different variants of my primary and complementary colors to separate surfaces and meet accessibility standards.

I created some transparent variants with 8-digit hex to help express depth on the classic dark gray surface (#121212).

Sass Colors

Bill of Technology

First, I created the dojo project. It's a simple web-app built with yarn, Parcel, and React. I created a detailed tutorial so others could build a toolchain from scratch.

Then, using the dojo project tutorial, I rebuilt this portfolio's toolchain. Here are the steps I took in the build process. Here's the Old Bill of Tech before I rebuilt the app.

yarn (package manager)

  • "Fast, reliable, and secure dependency management."
  • built by Facebook in 2016

Dependencies

"dependencies": {
  "bootstrap": "^4.4.1",
  "gh-pages": "^2.2.0",
  "jquery": "^3.5.1",
  "popper.js": "^1.16.1"
},
  • write simple jQuery commands to select HTML elements and modify them instead of complex JavaScript commands
  • jQuery commands work with many different browser DOMs, so you write once and works on all browsers
  • open-source MIT License (in the jQuery source code)
  • John Resig invented the jQuery library in 2006
  • CSS framework
  • grid system of containers, rows, and columns
  • easily use traditional CSS features like Flexbox within a row, for example
  • open-source MIT License
  • required dependency for Bootstrap
  • zero dependencies of its own
  • helps with positioning of pop-up elements
  • open-source MIT license

Development Dependencies

"devDependencies": {
  "parcel": "^2.0.0-alpha.3.2",
  "parcel-bundler": "^1.12.4",
  "sass": "^1.26.5"
},
  • "blazing fast, zero-configuration web application bundler"
  • Ryan Dahl (creator of Node.js and Deno JS frameworks) said that parcel is "really great" in his 10 Things I Regret About Node.js talk (at 23:20)
  • parcel is the CLI tool and parcel-bundler is the main library of code
  • "stylesheet language" that pre-compiles scss into css
  • can store variables and nest css styles

Vulnerabilities

My goal for this project was to write a simple, maintainble toolchain.

I used yarn for my package manager because it's more secure than npm.

I created the build toolchain (see dojo project) in April 2020 so my package manager yarn and all my dependencies are updated to the latest versions (written May 8, 2020). This helps prevent vulnerabilities.

GitHub's dependabot sends out automatic pull requests to bump versions so I can keep all my dependencies updated when patches come out.

Software License

This site has a MIT License. I chose the MIT License so others can use this open-source code without any licensing issues. It is free (in the sense of 'freedom'): you are free to use this code for commercial use. What's cool about the MIT License is it can be re-licensed under other licenses. The MIT License is compatible with many copyleft licenses, such as the GNU General Public License (GPL), which notably prevents commercial use.

Every code library in my bill of technology also has the MIT License, which ensures proper licensing of my site.

About

my personal website template & first open-source project! please use my template, customize the colors/fonts, & message me for a feature! responsive, mobile-first, accessible & dark-theme. semantic HTML and CSS from scratch with Bootstrap & Sass. toolchain built from my custom open-source template.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published