Coding Journal (née 100-days-of-code)

Description

I'm looking more for a good example of content and format of a repo where someone logs their daily progress
I'm not looking for tools one could use - I'm looking for actual examples of coding journals done well
— Kimberly (2022-07-06)

We hear you, Kimberly. Until those tools exist and/or are found, this'll have to do.

Setup

• Navigate to the repo — you already nailed this step 🔨
• Select Use this template
• Create a new repo of your choosing
  • Defaults are fine
  • Public should keep you accountable, but baby steps
• After a new repo has been created, select Code
  • Clone > Local > HTTPS
  • Copy the URL
  • Clone via the terminal (cf. Git Tutorial)

    mkdir -p ~/git
    git clone https://github.com/username/100-days-of-code.git

• Install either Notable (free) or Typora (one-time fee of $15)
  • I prefer the latter, but we'll demo with Notable

Usage

• Work on something programming-related
• Open Notable
• Change Data Directory > Select ~/git/100-days-of-code/notes
• Select the edit icon (✏️) on the menu bar
• Read up on Github Flavored Markdown
• Jot down some notes from your day
  
• Click the pencil again to stop editing
  
• Commit to your repo

  git status
  git add notes/log_1.md
  git commit -m "Create log_1.md" -m "First day of 100 days of code!! 🎉"
  git push -u origin main

• Rinse/repeat x100. (At least!)

BONUS

• Regenerate the 100 template markdown files (Ubuntu Linux example)
  • See: macOS and Windows instructions for installation

    # update repos, install python repo source, update repos, install python3.10.*
    sudo apt update \
    && sudo apt install software-properties-common -y \
    && sudo add-apt-repository ppa:deadsnakes/ppa -y \
    && sudo apt update \
    && sudo apt install python3.10 -y
    
    # clone repo
    mkdir -p ~/git
    cd ~/git
    git clone https://github.com/pythoninthegrass/100-days-of-code.git
    cd 100-days-of-code/
    
    # install python dependencies
    mkdir -p ~/.local
    python3 -m pip install -r requirements.txt
    
    # temporarily add `~/.local` python binaries to shell path
    export PATH="$HOME/.local/bin:$PATH"
    
    # check existing markdown notes
    ls -l notes/
    
    # (re)generate notes - overwrites existing ./notes/* files
    cd app/
    python3 main.py                         # no args defaults to today
    python3 main.py --start 1970/01/01      # args: `-s` or `--start` (YYYY/MM/DD) 
    
    # check fresh copies
    ls -l notes/
    cat notes/log_1.md

Resources

100 Days of Code

• Check out the Official Site for the #100DaysOfCode movement. Connect with others on the platform of your choice from this list: www.100DaysOfCode.com/connect Also, here is a invite link to the 100DaysOfCode Slack channel
• Read Join the #100DaysOfCode
• Fork this repo and commit to the Log or to the Alternative, rapid R1 Log (R1 stands for Round 1) daily. Example.