Hackathon hack-your-portfolio

Action Plan (WIP / Draft)

• Create a hidden repo on GitHub that has the same name as the username/ownername with basic README
• Set up some elementary testing via GitHub Actions (e.g. assert 'I love Hackathons and Test Driving' is in README)
• Deploy to GitHub Pages and set up GitHub to auto-deploy on code change
• Set up elementary JAMStack / Jekyll framework
• experiment with Jekyll themes
• experiment with Bridgetown (Jekyll alternative)
• explore some cool JavaScript to spice up JAMStack if theme does not suffice
• explore some APIs to connect to JAM Stack
• OPTIONAL - enhance CI/CD pipeline
• OPTIONAL - enhance basic testing
• OPTIONAL - explore OpenTelemetry
• OPTIONAL - explore Data / Telemetry visualisation - m.b. explore Grafana

Logs

Set up some elementary testing via GitHub Actions (e.g. assert 'I love Hackathons and Test Driving' is in README)

if curl -s -N 'https://github.com/terry-d-4tw/' | grep -q "I love Ruby too"; then
 echo "it worked! 🎉"; exit 0; else
 echo "it did not work 😔"; exit 1
fi

Set up elementary JAMStack / Jekyll framework

just create a

# _config.yml

theme: minima # minima is one of Jekyll's default themes

if you want to be able to develop locally and have nice things that come out of the box with Ruby's Jekyll installer (i.e. default 404 page and some extra configs) do:

cd ../
jekyll new terry-d-4tw --force # you need force since you are in a non-empty directory
cd terry-d-4tw
# ensure to add `webrick` gem to your gemfile, otherwise you will get an error when running `bundle exec jekyll serve`
bundle add webrick

now we can run it locally via

bundle exec jekyll serve -P 4001

experiment with Jekyll themes

Out of the box GitHub supports these themes - they are pretty basic, and in my view minima looks the best, but yet there is a lot to be desired.

Alternative is to use Minimal Mistakes theme, which is more involved, but hey, that's what we want, right?

Cool plugings/snippets/scripts: {% raw %}

{% include_relative README.md %} # include a file from the same repo

# add table of conents
* toc
{:toc}

{% endraw %}

Discovered alternative to Jekyll - Bridgetown (a fork of Jekyll with cool Ruby featureso)

refer this or some BridgeTown default README at the bottom

GitHub Pages will need some regigging to support Bridgetown, but it is doable, see this or https://andrewm.codes/deploy-bridgetown-to-github-pages/ also!

remove original deploy from main if you used GitHub Jekylls deploy. I went to setting unpublish website, changed deploy from branch to GH Action and re-run BridgeTown build/deploy action

Judging Criteria

Technology

How technically impressive was the hack? Was the technical problem the team tackled difficult? Did it use a particularly clever technique or did it use many different components? Did the technology involved make you go "Wow"?

Design

Did the team put thought into the user experience? How well designed is the interface?

Learning

Did the team stretch themselves? Did they try to learn something new? What kind of projects have they worked on before?

Adherence to Theme

Does the hack adhere to the event's theme? Does it implement that theme fully or just partially?

Originality

Has this project been done before at hackathons in the past? How creative is their project in solving the problem at hand?

Completion

Does the hack work? Did the team achieve everything they wanted?

Bridgetown Website README

Welcome to your new Bridgetown website! You can update this README file to provide additional context and setup information for yourself or other contributors.

Table of Contents

• Prerequisites
• Install
• Development
• Commands
• Deployment
• Contributing

Prerequisites

• GCC
• Make
• Ruby
  • >= 2.7
• Bridgetown Gem
  • gem install bridgetown -N
• Node
  • >= 12
• Yarn

Install

cd bridgetown-site-folder
bundle install && yarn install

Learn more: Bridgetown Getting Started Documentation.

Development

To start your site in development mode, run bin/bridgetown start and navigate to localhost:4000!

Use a theme or add some plugins to get started quickly.

Commands

# running locally
bin/bridgetown start

# build & deploy to production
bin/bridgetown deploy

# load the site up within a Ruby console (IRB)
bin/bridgetown console

Learn more: Bridgetown CLI Documentation

Deployment

You can deploy Bridgetown sites on hosts like Render or Vercel as well as traditional web servers by simply building and copying the output folder to your HTML root.

Read the Bridgetown Deployment Documentation for more information.

Contributing

If repo is on GitHub:

1. Fork it
2. Clone the fork using git clone to your local development machine.
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create a new Pull Request