Example: Code Journal Entry

README.md

Example: Dated Code Journal Entry

Jan 17, 2022

• TODO: Figure out how to translate entries written in non-english to english so I can mark them and the student doesn't have language as a barrier to learning.
  • Translate Web Pages
    • ref: Bryan from WBDV
• TODO: Add Laws of UX to UX Library

Goal: Define separate user stories and flows that I can base new lab activities for future lessons.

• I currently have multiple Gist lists for using Git that are kinda messy. Time to clean that up.
  • Publish a webpage with Git and GitHub Pages
    • clone repo first
  • Deploy a static website to GitHub Pages
    • git init and push
  • Git: First-time setup
    • old gist that needs to be refactored
• Some of my exercises overlap
  • For example, the add/commit/push instructions are the same for repos that have been cloned and those that have been initialized locally and then pushed.

User Stories

User Story 1

• Who
  • As a web developer
• What
  • I want to clone one of my GitHub repos
• Why
  • So that I can work on my project from my home laptop.

User Story 2

• "As a web developer I want to push an existing coding project to GitHub Pages so that I can deploy my portfolio website in time for this afternoon's job interview."

User Story 3

• "As a web development student, I want to fork and clone a repo so that I can submit a Pull Request so that I can add my favourite Flexbox course to the Program Library of resources without needing write access to the site."

User Flows

User Flow: "As a web developer I want to push an existing coding project to GitHub Pages so that I can deploy my portfolio website in time for this afternoon's job interview."

1. Navigate to the root of the web project in the terminal;
2. Check if you're already in a repo: $ git status -> "fatal, not a repo"
3. $ git init -> "Created an empty repo"
4. $ git add . or $ git add --all
5. $ git commit -m "Initial commit"
6. Go to GitHub account
7. Click "Add New Repo". Redirect: New Repo form
8. Fill out form
   • name of repo
   • Public repo
   • Leave "Initialize with a README" UNCHECKED
   • Submit -> redirect to sample code for pushing
9. Copy middle code block

   …or push an existing repository from the command line

10. Go to terminal and paste code, hit enter -> magic happens and your code is now on GH
11. Refresh GitHub page -> code should show up
12. Got to Settings -> Pages -> main branch -> Save