[Document]

### [Title]: Comprehensive GIT Beginners Guide from Scratch - Part 1
###          - Git and github configuration
###
### [Published]: 14/09/2022
###
### [Description]:
###
### This is a complete walkthrough from scratch of a local
### git configuration and github remote repository utilization

### ---------------------------------------------------- ##

## Table of contents

1.      TL;DR Condensed Version: First time setup

1.1     Initial Local configuration
1.2     Initial Remote Configuration & Github Authentication
1.3     Normal Workflow

2.      Git for the absolut beginner from scratch

2.1     Initial Basic local configuration with examples
2.1.1   Adding content to our project
2.1.2   Adding the project to our local git repository

2.2     Github Authentication via HTTPS
2.2.1   Creating a new remote repository
2.2.2   Adding a remote URL to work with AuthToken authentication

2.3     Git Authentication via SSH
2.3.1   Generate new ssh keys
2.3.2   Edit ssh config file
2.3.3   Upload your public key to github
2.3.4   Adding a remote URL to work with PublicKey authentication

### ---------------------------------------------------- ###

## TL;DR Condensed Version: First time setup

## Local Configuration:

mkdir -p ~/development/git-test; cd ~/development/git-test/
git init
git config --global user.name "username"
git config --global user.email "email@domain.com"
git config --global color.ui true
git config --global core.editor nano

echo ".gitignore" > ./gitignore
echo "# Hello World" > ./README.md
git add .
git commit -m "README.md First commit"

## --- ##


## Remote Configuration:

## [Note]: You have to setup the authentication on the github website first!
## Authentication methods for github include 'Bearer AuthToken' via HTTPS
## or 'SSH PublicKey AUTH'

## Refer to [2.2] and [2.3] for indepth instructions

## Link your local repository 'git-test' to the remote repository:

## Choose:
1. HTTPS: git remote add origin https://<Github-Username>:<AuthToken>@github.com/<Github-Username>/git-test.git
2. SSH git remote add origin git@github.com:<Username>/test-repo.git

## Create remote repository 'git-test':
## [Note]: You can also create the repository manually at the github website!
## [URL]: https://github.com/new

curl -u <Username>:<AuthToken> https://api.github.com/user/repos -d '{"name":"git-test"}'

## Push the 'main' branch of repository 'git-test' to the remote server:
pit push -u origin main

## --- ##


## Normal Workflow:

[Begin]:

  cd ~/path/to/repository
  git pull (optional)
  - Work on your project (Add/Change content)
  git add .
  git commit -m "Meaningful summary of the changes"
  git push (optional)

[End]


### ---------------------------------------------------- ###

## Git for the absolut beginner from scratch

## Create a new local git-repository;

mkdir -p ~/development/git-test; cd ~/development/git-test/

## Initialisation of the repository 'git-test':

git init

## Git mandatory configuration. The '--global' flag sets these
## values user-account wide in file (~/.gitconfig)

git config  --global user.name="Username"
git config  --global user.email="email@domain.com"
git config  --global credential.helper cache

## [Note]: The local configuration file is named: (git-test/).git/config
## and will override the global configuration for the current repository

## List the configuration settings:

git config -l

## Adding content to the repository - main branch:

echo "# Hellow World" > README.md

## Add the '.gitignore file' where you put all files and directories
## that you dont want to get added to the remote repository:

echo ".gitignore" > .gitignore

## Apply changes to the repository and add a 'commit comment':

git add .
git commit -m "My first git commit"

## -------------------------------------------------------------- ##

## Github Authentication via HTTPS

## HTTPS Authentication URL Format:
## https:://<Username>:<AuthToken>@github.com/<Username>/<Repo-Name>.git

## --- ##

## Generate a new Bearer AuthToken:
## [URL]: https://github.com/settings/tokens

1. Button 'Generate new token'
2. Choose a Name for your token
3. Set an expiration date
4. Select: [repo], [write:packages], [delete:packages], [admin:repohook], [user], [project]
5. Button: 'Generate Token'

## --- ##

## Adding a new remote  HTTPS URL (named: origin) for the 'main' branch:
## [Note]: To change the remote URL use 'set-url' instead of 'add':

git remote add origin https://TheMunkyHive:<AuthToken>@github.com/TheMunkyHive/git-test.git

## Create the remote Github Repository 'git-test'

curl -u <Username>:<AuthToken> https://api.github.com/user/repos -d '{"name":"git-test"}'

## Initial Push to the Github Repository 'git-test':

git push -u origin main

## Consecutive Push'es/Pulls only require the following commands:

git push
git pull


## -------------------------------------------------------------- ##

## Git Authentication via SSH:

## 1. Generate new ssh keys named 'git_rsa(.pub)':
## [Note]: Github stopped supporting weak cyphers like rsa-sha1

ssh-keygen -t ecdsa -f ~/.ssh/git_key

## 2. Edit ssh config file: ~/.ssh/config

Host github.com
User git
Hostname github.com
PreferredAuthentications publickey
IdentityFile /home/<username>/.ssh/git_key
IdentitiesOnly yes

## --- ##

## 3. Upload your public key to github's website:
## [URL]: https://github.com/settings/keys

1. Button 'New SSH Key'
2. Choose a Name for your key
3. Paste your PUBLIC! SSH Key into the textarea
4. Button: 'Add SSH Key'

## --- ##

## Creating a new branch:

git checkout -b new

## SSH Authentication URL Format:
## git@github.com:<Username>/<Repo-Name>.git

## Adding a new remote  SSH URL (named: newrepo) for the 'new' branch:
git remote add newrepo git@github.com:TheMunkyHive/git-test.git

## Push branch 'new' to the remote repository 'git-test' via SSH:
git push newrepo new


## -------------------------------------------------------------- ##

[/Document]