Live Online Workshop for ULSA and HSRW by Harley Lara - 2022-10-06

Workshop details:

• Topic: Tools, workflow and resources for effective development
• Description: Hardware and/or Software project development can be a long and complex process, but with the right set of tools everything can be faster and more efficient from the developer's point of view. This workshop is based on providing tools for developers to have a seamless process, producing quality software and hardware. In collaboration with ULSA Nicaragua and the EOLab of the HSRW.
• Date: 06 October 2022
• Time: from 16:00 to 18:00 (CEST)
• Location: IoT Lab, room 02 02 510 HSRW. Zoom meeting for ULSA.
• Instructor: Harley Lara
• Contact: harley-nelson<DOT>lara-alonso<AT>hsrw<DOT>org

Download all the files here: example_files.zip

• bash-hello.sh: Print message in the terminal
• tmux-fzf.sh: fuzzy search over a group of specified directories
• bash-software.sh: Basic bash script to install a set of packages
• ansible-software.yml: Basic playbook to install a set of packages
• bash-software-tags: Minimal and basic tag implementation to emulate ansible tags using bash script

hello-bash.sh

#!/bin/bash
 
echo "hello bash scripting"

tmux-fzf.sh

#!/bin/bash
 
# Used the next line to set the list of directories
DIRECTORIES="~/ ~/Documents ~/Desktop"
# Uncommend the next line if you are using a external file
# for track the list of directories
# DIRECTORIES=$(cat ~/EXTERNAL-FILE | tr "\n" " ")
# Note about the external file
#       Format of the file:
#           ~/ 
#           ~/Documents
#           ~/Desktop
#       One directory per line
 
if [[ $# -eq 1 ]]; then
    SELECTED=$1 && [[ "$SELECTED" == '.' ]] && SELECTED="$PWD"
else
    SELECTED=$(find $DIRECTORIES -mindepth 1 -maxdepth 1 -type d | fzf)
fi
 
if [[ -z $SELECTED ]]; then
    exit 0
fi
 
SELECTED_NAME=$(basename "$SELECTED" | tr . _)
SELECTED_NAME=${SELECTED_NAME:0:8}
 
if [[ -n $TMUX ]]; then
    # inside tmux
    tmux switch-client -t "$SELECTED_NAME" || \
    tmux new-session -ds "$SELECTED_NAME" -c "$SELECTED" && \
    tmux switch-client -t "$SELECTED_NAME"
elif [[ -z $TMUX ]]; then
    # outside tmux
    tmux new-session -s "$SELECTED_NAME" -c "$SELECTED" || \
    tmux attach -t "$SELECTED_NAME"
fi

install-some-software-packages.sh

#!/bin/bash
 
sudo apt update && \
apt-get install -y \
    build-essential \
    cmake \
    pkg-config \
    libpthread-stubs0-dev
 
sudo apt install -y \
    curl \
    htop \
    python3-pip

Encryption:

$> ansible-vault encrypt FILE_NAME

Decryption:

$> ansible-vault decrypt FILE_NAME

Note 1: if the platform is not specified as Windows, Linux or MacOS, consider the software mentioned as Cross-platform (available on all).

Note 2: Linux and MacOS are Unix-based operating systems

• Shells (For Unix-based OS):
  • Bash (RECOMMENDED)
  • Fish
  • Ksh
  • Zsh

• Terminal Emulators (matter of personal choice):
  • Konsole (for Linux): Default in KDE’s desktop environment
  • kitty: GPU based terminal emulator
  • Alacritty: GPU based terminal emulator
  • Terminator (for Linux): Terminal and terminal multiplexer
  • PuTTY (for Windows): Mainly ssh, serial and telnet connection
  • Windows Terminal (for Windows): “Terminal application for users of command-line tools and shells like Command Prompt, PowerShell, and WSL” (not installed by default)
  • Find more here

• Terminal Multiplexers (for Unix-based OS):
  • Terminator: (Requires a graphical environment to run)
  • Screen: Installed by default in many Linux distributions
  • Tmux: “It lets you switch easily between several programs in one terminal” (RECOMMENDED)
    • Article How does Tmux works
    • Tmux Cheatsheet

• Automation:
  • Ansible: “Ansible is a suite of software tools that enables infrastructure as code.”
  • Shortcuts and Macros
    • AutoHotkey (for Windows): “The ultimate automation scripting language for Windows.”
    • AutoKey (for Linux): “A desktop automation utility for Linux and X11.”
    • BetterTouchTools (for MacOS)

• Tiling Window Managers:
  • i3 (for Linux)
  • bug.n (for Windows)
  • Amethyst (for MacOS)
  • More about tiling window managers here

• Lightweight Markup Languages:
  • Markdown and flavors
  • MediaWiki
  • DokuWiki
  • reStructuredText
  • AsciiDoc
  • Others options here

• Hosting Docs:
  • Markdown file in git repositories
  • Personal Wikis: DokuWiki, MediaWiki …
  • SSGs (Static Site Generator):
    • Github Pages
    • Gitlab Pages

• Diagrams:
  • Mermaid markdown extension for text-based diagrams.
  • Draw.io graph drawing software

• Screenshots:
  • Flameshot “powerful, yet simple to use open-source screenshot software”