installation and configuration

Installation & Configuration Guide

This guide provides the necessary steps to install Git and set up your primary Integrated Development Environment (IDE). Follow these steps to prepare your local development environment.

---

1. Install Git

Git is required for all version control operations.

Operating System	Installation Guide	Notes
Windows	https://git-scm.com/download/win	Use default installer settings.
macOS	brew install git	Requires Homebrew. Git may prompt for installation via Xcode Tools.
Linux (Debian/Ubuntu)	sudo apt update && sudo apt install git	Use your distro’s package manager (apt, dnf, yum).

---

2. Set Up Your IDE

Below are the recommended and supported IDEs for the practicum. Each IDE includes a collapsible setup guide for installation, Git configuration, and recommended plugins.

---

Visual Studio Code (Recommended)

View VS Code Setup

Installation

• Download: https://code.visualstudio.com/
• Install using default options (recommended for class).

Git Integration

• VS Code automatically detects your Git installation.
• Open the Source Control panel to see Git status.
• No additional configuration required.

Recommended Extensions

• Prettier – Code Formatter
• ESLint
• GitLens — Git supercharged
• Python Extension Pack (if needed)
• Markdown All-in-One

---

WebStorm

View WebStorm Setup

Installation

• Download: https://www.jetbrains.com/webstorm/download/

Git Integration

• Open File → Settings → Version Control → Git
• Ensure Git executable path is detected (e.g., git)
• Click Test to verify
• When opening a project, choose Enable Git Integration if prompted

Recommended Plugins

• Prettier
• ESLint
• GitToolBox
• Markdown (built-in)

---

Android Studio

View Android Studio Setup

Installation

• Download: https://developer.android.com/studio
• Install with Android SDK & recommended components.

Git Integration

• Open File → Settings → Version Control → Git
• Verify Git path is correct
• Click Test
• Attach Git to a project via:
  • VCS → Enable Version Control Integration → Git

Recommended Plugins

• GitToolBox
• CodeGlance
• Prettier (if applicable)
• Kotlin (built-in)

---

3. Configure Git Usernames, SSH Keys, and Workspace Settings

These steps are required before starting work in any repository.
To reduce visual clutter, each section below is collapsible.

---

A. Set Your Git Username & Email

View Git Username & Email Setup

Configure Your Identity

Use the name and email associated with your GitHub account:

git config --global user.name "Your Name"
git config --global user.email "your-email@example.com"

Verify:

git config --global --list

B. Generate and Add an SSH Key

View SSH Key Setup

1. Create SSH Key

ssh-keygen -t ed25519 -C "your-email@example.com"

When prompted, press Enter to accept the default file location.

2. Start SSH agent

eval "$(ssh-agent -s)"

3. Add your key

ssh-add ~/.ssh/id_ed25519

4. Add your public key to Github

cat ~/.ssh/id_ed25519.pub

• Add at: https://github.com/settings/ssh/new
• Give it a recognizable name (e.g., “Laptop Key”)

5. Test Your Github Connection

ssh -T git@github.com

C. Configure Global Workspace Settings

View Workspace Settings

1. Set Your Default Git Editor VS Code:

git config --global core.editor "code --wait"

Webstorm:

git config --global core.editor "webstorm --wait"

2. Recommended Git defaults

git config --global pull.rebase false
git config --global init.defaultBranch main

Windows Line Endings:

git config --global core.autocrlf true

macOS/Linux Line Endings:

git config --global core.autocrlf input

3. Enable colored Git output

git config --global color.ui auto