Modernize the dev guide - add zsh config

Author: jmike

11-big-sur/install-macos-big-sur.md

@@ -23,7 +23,7 @@
 
 ### Install macOS Big Sur
 
-> Before you proceed with installing macOS please make sure you have backed up your previous settings, keys and data. If you need help to organize your thoughts, refer to our [backup guide](/backup/backup-guide.md).
+> Before you proceed with installing macOS please make sure you have backed up your previous settings, keys and data. If you need help to organize your thoughts, refer to our [backup guide](/backup.md).
 
 1. Plug the USB disk to your machine;
 2. Go to `System Settings > Startup Disk`;

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2016 Dimitrios C. Michalakos
+Copyright (c) 2015-2021 Dimitrios C. Michalakos
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,17 +1,23 @@
 # MacOS-Dev-Setup
 
-Best practices to setup and configure macOS for developers.
+An opinionated guide to setup and configure macOS for developers.
 
 ### Table of Contents
 
+##### Backup
+
+If you are coming from an existing macOS installation, make sure you have backed up your data and settings before proceeding with any changes.
+
+- [Backup Guide](backup.md)
+
 ##### Operating System
 
-At the time of writing the latest macOS version is Big Sur (11.1).
+At the time of writing the latest macOS release is Big Sur (11.1).
 
 1. [Install macOS Big Sur](/11-big-sur/install-macos-big-sur.md)
 2. [Secure macOS Big Sur](/11-big-sur/secure-macos-big-sur.md)
 
-If you are looking for an older macOS version please consider the following:
+If you are looking for an older macOS version please consider the following guides:
 
 <details>
   <summary>Sierra (10.12)</summary>
@@ -30,26 +36,30 @@ If you are looking for an older macOS version please consider the following:
 
 ##### General
 
-- [Setup the Terminal](setup-terminal.md)
-- [Install Homebrew](install-homebrew.md)
+- [Homebrew](homebrew.md)
+- [Keyboard Configuration](keyboard-config.md)
 
 ##### Privacy
 
-- [Setup PGP](setup-pgp.md)
+- [PGP](pgp.md)
 
 ##### Version Control
 
-- [Install Git](install-git.md)
+- [Git](git.md)
+
+##### Shell
+
+- [zsh](zsh.md)
 
 ##### Programming Languages & Platforms
 
-- [Install Node.js & npm](install-node-npm.md)
+- [Node.js & npm](node-npm.md)
 
 ##### Databases
 
-- [Install MySQL](install-mysql-5.6.md)
-- [Install PostgreSQL](install-postgres.md)
+- [MySQL 5.6](mysql-5.6.md)
+- [PostgreSQL](postgres.md)
 
 ##### IDEs & Editors
 
-- [Install Sublime Text 3](install-sublime-3.md)
+- [Sublime Text 3](sublime-3.md)

backup-guide.md renamed to backup.md

@@ -0,0 +1,103 @@
+# Git
+
+Git is one of the most popular version control systems. It comes pre-installed on macOS. However, Apple's bundled version of Git is not as well-maintained as the official Git repo.
+
+### Installation
+
+1. Make sure you have installed Homebrew on your system - if not, read the [Homebrew](homebrew.md) guide;
+
+   ```bash
+   which brew
+   ```
+
+2. Open terminal and run the following command:
+
+   ```bash
+   brew install git
+   ```
+
+3. Verify git has been installed.
+
+   ```bash
+   git --version
+   ```
+
+#### Configuration
+
+1. Set Git editor;
+
+```bash
+git config --global core.editor "nano"
+```
+
+2. Set Git default push behaviour;
+
+```bash
+git config --global push.default simple
+```
+
+3. Set Git user;
+
+```bash
+git config --global user.name "Your Name"
+git config --global user.email [email protected]
+```
+
+#### Git completion in bash
+
+> Ignore this section if you are NOT a bash user.
+
+1. Create configuration files;
+
+   ```bash
+   touch ~/.bash_profile
+   touch ~/.git-completion.bash
+   touch ~/.git-prompt.sh
+   ```
+
+2. Populate `.git-completion.bash` with [https://github.com/git/git/blob/master/contrib/completion/git-completion.bash](https://github.com/git/git/blob/master/contrib/completion/git-completion.bash);
+3. Populate `.git-prompt.sh` with [https://github.com/git/git/blob/master/contrib/completion/git-prompt.sh](https://github.com/git/git/blob/master/contrib/completion/git-prompt.sh);
+4. Update permissions of `.git-completion.bash` and `.git-prompt.sh`;
+
+   ```bash
+   chmod 755 ~/.git-completion.bash
+   chmod 755 ~/.git-prompt.sh
+   ```
+
+5. Populate `.bash_profile`, as follows:
+
+   ```bash
+   #!/bin/bash
+
+   export PATH="/usr/local/bin:$PATH"
+
+   source ~/.git-completion.bash
+   source ~/.git-prompt.sh
+
+   MAGENTA="\[\033[0;35m\]"
+   YELLOW="\[\033[0;33m\]"
+   BLUE="\[\033[34m\]"
+   LIGHT_GRAY="\[\033[0;37m\]"
+   CYAN="\[\033[0;36m\]"
+   GREEN="\[\033[0;32m\]"
+   GIT_PS1_SHOWDIRTYSTATE=true
+   export LS_OPTIONS='--color=auto'
+   export CLICOLOR='Yes'
+   export LSCOLORS=gxfxbEaEBxxEhEhBaDaCaD
+
+   export PS1=$LIGHT_GRAY"\u@\h"'$(
+       if [[ $(__git_ps1) =~ \*\)$ ]]
+       # a file has been modified but not added
+       then echo "'$YELLOW'"$(__git_ps1 " (%s)")
+       elif [[ $(__git_ps1) =~ \+\)$ ]]
+       # a file has been added, but not commited
+       then echo "'$MAGENTA'"$(__git_ps1 " (%s)")
+       # the state is clean, changes are commited
+       else echo "'$CYAN'"$(__git_ps1 " (%s)")
+       fi)'$BLUE" \w"$GREEN": "
+
+   alias ll='ls -lah'
+   alias gg='git status -s'
+   ```
+
+Please note: You need to restart your terminal for the settings to take effect.

git.md

@@ -1,8 +1,8 @@
-# Install Homebrew
+# Homebrew
 
-Homebrew is an excellent open-source solution to install software packages on your Mac.
+Homebrew is an excellent open-source package manager for Mac.
 
-### Quick setup
+### Installation
 
 ```bash
 ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

install-homebrew.md renamed to homebrew.md

@@ -0,0 +1,7 @@
+# Configure Keyboard
+
+### Edit keyboard type speed
+
+1. Go to `System Settings > Keyboard > Keyboard`;
+2. Drag the _Key Repeat_ slider to the right-most _Fast_;
+3. Drag the _Delay Until Repeat_ slider to the right-most _Short_.

install-git.md

@@ -1,18 +1,18 @@
-# Install MySQL
+# MySQL 5.6
 
-### Install MySQL Server
+### MySQL Server installation
 
 1. Visit [http://dev.mysql.com/downloads/mysql/](http://dev.mysql.com/downloads/mysql/);
 2. Download the latest .dmg archive;
 3. Open the downloaded file and follow on-screen instructions;
 4. You will receive a prompt window with the MySQL server password - store it in a temporary location;
-5. Append the following to your .bash_profile;
+5. Append the following to your `~/.bash_profile` or `~/.zshrc`;
 
-  ```
-  export PATH=${PATH}:/usr/local/mysql/bin
-  ```
+```
+export PATH=${PATH}:/usr/local/mysql/bin
+```
 
-##### Setup MySQL Preference Pane
+##### MySQL Preference Pane
 
 The _MySQL preference pane_ enables you to start, stop, and control MySQL server within _System Preferences_.
 
@@ -31,22 +31,22 @@ Please note: This is an important step in order to be able to connect with MySQL
 2. Make sure the MySQL server is running. If not, start the server;
 3. Run the following command in a terminal;
 
-  ```bash
-  mysql --user root --password
-  ```
+```bash
+mysql --user root --password
+```
 
-  Enter the server password you were given during MySQL server installation.
+Enter the server password you were given during MySQL server installation.
 
 4. Execute the following SQL command;
 
-  ```sql
-  SET PASSWORD = PASSWORD('<new password/>');
-  ```
+```sql
+SET PASSWORD = PASSWORD('<new password/>');
+```
 
 5. Enter `quit` to exit the MySQL CLI session;
 6. Store password in a secure location, e.g. [KeePassX](https://www.keepassx.org/).
 
-### Install MySQL Workbench
+### MySQL Workbench installation
 
 MySQL Workbench is the official MySQL client. It's free, as in beer, and quite powerful.
 

keyboard-config.md

@@ -1,6 +1,6 @@
-# Install Node.js & npm
+# Node.js
 
-### Install Node.js & npm
+### Installation
 
 1. Visit [https://nodejs.org/en/download/current](https://nodejs.org/en/download/current);
 2. Download the latest Node.js dmg archive, which comes bundled with the npm client. If you don't know which file to download look for the "macOS Installer";
@@ -42,7 +42,7 @@ If you are planning to publishing modules to the npm registry you should login w
 
 ### Working with private modules
 
-1. Append the following to your .bash_profile;
+1. Append the following to your `~/.bash_profile` or `~/.zshrc`;
 
 ```bash
 export NPM_TOKEN=$(cat ~/.npmrc | awk -F'authToken=' '{print $2}')