diff --git a/README.md b/README.md index 1c17ba8..2a1f8d1 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,7 @@ Please follow the correct path below, based on the course that you are registere ### Begin by selecting your Operating System - -[MacOS](./system-setup/README.md) | [Ubuntu Linux](./system-setup/README.md) | [Windows 10](./windows/windows-10.md) | [Windows 11](./windows/windows-11.md) - +[MacOS](./system-setup/mac/README.md) | [Ubuntu Linux](./system-setup/linux/README.md) | [Windows 10](./system-setup/windows/windows-10.md) | [Windows 11](./system-setup/windows/windows-11.md) ## Path 2 - For students registered for `Ops-102`, `Ops-201`, `Ops-301`, or `Ops-401` only diff --git a/system-setup/linux/1-environment.md b/system-setup/linux/1-environment.md new file mode 100644 index 0000000..1192727 --- /dev/null +++ b/system-setup/linux/1-environment.md @@ -0,0 +1,34 @@ +# Backup Your Terminal/Shell Environment + +This section will talk about how to update the Terminal's look and feel, as well as how to edit files using the command line editor, `nano` + +At the end of this guide, we will add some color to your command line, and your command line will be formatted for development. + +## Backing up files + +The first thing we'll do is backup your existing terminal setup. + +There are a lot of ways that your terminal can be set up determined by different configuration files. + +We want to remove the old ways so we can start with a clean slate. + +Make back ups of the files listed below. You may get a `No such file or directory` error for some of them. That's ok. + +- `mv ~/.bashrc .bashrc.bak` +- `mv ~/.bash_profile .bash_profile.bak` +- `mv ~/.profile .profile.bak` +- `mv ~/.zshrc .zshrc.bak` + +## Install Z Shell + +```bash +sudo apt-get install zsh +``` + +After installing, type `zsh`. Zsh will ask you to choose some configuration. We will do this later by installing `oh-my-zsh`. Chose option 0 to create the config file (prevent this message to show again). + +Now, let's move on to getting our development applications installed. + +--- + +### [⇐ Previous](./README.md) | [Next ⇒](./2-apt.md) diff --git a/system-setup/linux/10-vscode.md b/system-setup/linux/10-vscode.md new file mode 100644 index 0000000..31fb90f --- /dev/null +++ b/system-setup/linux/10-vscode.md @@ -0,0 +1,35 @@ +# Install VSCode Text Editor + +Now it's time to install VSCode Text Editor, a sophisticated text editor for code, markup, and prose. + +> **Follow the below instructions in order**, paying attention to any notes specific to Windows or Mac, depending on your operating system. + +## Get Started + +- Close any open terminal windows. +- Download [VSCode](https://code.visualstudio.com/download) and install. +- If this window displays during set up, be sure the following boxes are selected +![VSCode](../vscode.png) + +### Install Additional VSCode Extensions + +We'll now be adding some functionality to your new code editor by installing a number of extensions. + +- You can open VSCode through your terminal using `code .` +- On the bottom left hand side you will see a settings ("gear") icon. +- Click this, then click "Extensions". +- A side-bar will slide out and at the top you can search for the listed extensions below, and click the green 'Install' button for each: + - liveserver + - ESLint + - markdownlint + - editorconfig + - HTML Preview + - Thunder Client + +There are many other extensions to choose from that will make your coding life a lot easier. Your instructors, TAs and classmates will all be great resources as to what works well for them. + +[VSCode's documentation](https://code.visualstudio.com/docs) is excellent. Review it now to familiarize yourself with the basics. + +--- + +### [⇐ Previous](./9-eslint.md) | [Next ⇒](./11-verify.md) diff --git a/system-setup/linux/11-verify.md b/system-setup/linux/11-verify.md new file mode 100644 index 0000000..5510b37 --- /dev/null +++ b/system-setup/linux/11-verify.md @@ -0,0 +1,38 @@ +# Verify Your Setup Part 1 + +> By the time you’ve completed the guide, you should be able to run the following commands in your terminal and see the expected output. Your versions may be slightly different than what is listed here due to recent updates. + +- `code --version` + - `1.64.2` +- `git --version` + - `git version 2.34.1` +- `node --version` + - `v17.31.1` +- `npm --version` + - `8.3.0` +- `eslint --version` + - `v8.1.0` +- `tree --version` + - `tree v2.0.1 (c) 1996 - 2018 ...` +- `git config --list` should contain at least the following: + - `user.name=YOUR NAME` + - `user.email=YOUR EMAIL` + - `core.editor=code --wait` + - `init.defaultbranch=main` + - Type the letter `q` to exit the config screen and return to the previous screen. +- `code .` + - should open VS Code with your current folder contents + +## Verify Your Setup Part 2 + +Run the following command + +```bash +curl -Ls https://bit.ly/3qMWhbE | bash +``` + +You should get a successful message. If you do not see `By gum, you've done it!`, look at the output from the steps in part 1 to begin troubleshooting. Get TA assistance as necessary. + +--- + +### That's It! [Back To the Beginning](../../README.md) diff --git a/system-setup/linux/2-apt.md b/system-setup/linux/2-apt.md new file mode 100644 index 0000000..934792c --- /dev/null +++ b/system-setup/linux/2-apt.md @@ -0,0 +1,15 @@ +# Installing and Updating the Linux App Manager + +For some things on your system, we will be using `apt` to install applications. The first thing we'll want to do is get that up to date with all of the latest versions and information + +**OPEN YOUR UBUNTU TERMINAL** and let's get started! + +1. Type `sudo apt-get update`. + - Provide your password, when prompted (***Note:*** *You will not have any visual feedback on your screen as you type. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes.*) +1. Once that is complete, type `sudo apt-get upgrade`. Press `y` when prompted. +1. Once that is done, type `sudo apt autoremove`. This will remove any packages that are no longer needed. +1. Install the "Build Essentials" kit with this command: `sudo apt-get install build-essential` + +--- + +### [⇐ Previous](./1-environment.md) | [Next ⇒](./3-homebrew.md) diff --git a/system-setup/linux/3-homebrew.md b/system-setup/linux/3-homebrew.md new file mode 100644 index 0000000..6e1f2e6 --- /dev/null +++ b/system-setup/linux/3-homebrew.md @@ -0,0 +1,74 @@ +# Install "Homebrew" + +Homebrew is a tool that simplifies installing applications on your machine. Think of it like an app store for your computer. + +--- + +## Verify if Homebrew is already installed + +- In your terminal, run: `brew --version` + - *If output is similar to:* `Homebrew 3.4.11` + - Run: `brew update` to get latest updates + - Move on to [next page](./4-git.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +In your terminal, enter the following command: + +- `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` +- You will be prompted several times along the way. Enter your password when prompted, accept all the defaults, say "Yes" if prompted. (***Note:*** *You will not have any visual feedback on your screen as you type. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes.*) +- Once the main installation finishes (could take up to 30 minutes), enter these commands, one at a time in your terminal - they should produce no errors, and do not produce success messages: + - `test -d ~/.linuxbrew && eval $(~/.linuxbrew/bin/brew shellenv)` + - `test -d /home/linuxbrew/.linuxbrew && eval $(/home/linuxbrew/.linuxbrew/bin/brew shellenv)` + +Once the installation has completed, **run:** + + `brew doctor` + +**if** return output is: + +```bash +Your system is ready to brew +``` + +**or** return output is: + +```text +Please note that these warnings are just used to help the Homebrew maintainers +with debugging if you file an issue. If everything you use Homebrew for is +working fine: please don't worry or file an issue; just ignore this. Thanks! +``` + +**then run:** + +`brew update` + +**else if** return output is: + +```bash +brew: command not found +``` + +**then** run these commands + +1. ```echo 'export BREW_HOME="/home/linuxbrew/.linuxbrew/bin"' >> $HOME/.zprofile``` +1. ```echo 'export PATH="$PATH:$BREW_HOME"' >> $HOME/.zprofile``` +1. ```reset``` + + +> **If `brew update` still fails to run, [click here](../../error/error.md) and do not continue with the following steps until you have Homebrew properly installed** + +## Install "gcc" + +In order for Homebrew to install other applications, it needs a tool called **gcc** to assist itself. + +Run this command in your terminal: + +`brew install gcc` + +When that completes, you will be returned to the command prompt and can move on to the next steps. + +--- + +### [⇐ Previous](./2-apt.md) | [Next ⇒](./4-git.md) diff --git a/system-setup/linux/4-git.md b/system-setup/linux/4-git.md new file mode 100644 index 0000000..95ffbf8 --- /dev/null +++ b/system-setup/linux/4-git.md @@ -0,0 +1,68 @@ +# Git + +## Verify if Git & GitHub are already installed: + +- In your terminal, run: `git config --list` +- **Note**: To exit the git config --list screen, type the letter `q` in your terminal + - *If the output is similar to:* + + - ```bash + user.name=[Your name is here] + user.email=[Your email is here] + code.editor=code --wait + init.defaultbranch=main + ``` + + - Then move on to [next page](./5-tree.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Install and Configure Git and GitHub + +Run the following command to ensure that you have the most recent version of git: + +`brew install git || brew upgrade git` + +## Setup GitHub for "Authentication" + +In order to use Git locally in a secure manner, we need to connect our computer with github.com. + +[GitHub Instructions: Caching GitHub credentials](https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git) + +- Install CLI by completing the following steps: + - run in terminal: `brew install gh` + - run in terminal: `gh auth login` + - Use arrow key to select **GitHub.com** + - Select **HTTPS** + - When prompted with Authenticate Git with your GitHub credentials (Y / n). Press `y` and enter + - Click **Login with a web browser** + - Copy the one time code shown in yout terminal and then press enter. This will open github.com in a web page. + - If not signed in, you will be prompted to signin. + - Github will prompt you for the one time code. Enter in the appropriate boxes. + - Click **Authorize github** + - You can close the web browser and press enter in your terminal to continue. + +## Git Config + +Like artists, programmers sign their work. Let's configure Git to sign your commits with your name and email address. + +**WARNING:** Before running the following commands one line at at time, replace `YOUR FULL NAME` and `YOUR EMAIL ADDRESS` with the name and email from [Your GitHub Account](https://github.com/settings/profile) + +```bash +git config --global user.name 'YOUR FULL NAME' +``` + +```bash +git config --global user.email 'YOUR EMAIL ADDRESS' +``` + +```bash +git config --global core.editor "code --wait" +``` + +```bash +git config --global init.defaultbranch main +``` + +### [⇐ Previous](./3-homebrew.md) | [Next ⇒](./5-tree.md) diff --git a/system-setup/linux/5-tree.md b/system-setup/linux/5-tree.md new file mode 100644 index 0000000..ccd0315 --- /dev/null +++ b/system-setup/linux/5-tree.md @@ -0,0 +1,46 @@ +# Tree + +Tree is a useful application that will allow you to look at a directory structure and files that are in a directory. + +```text +# Example of what an output may look like +── courses + ├── code102 + ├── code201 +``` + +--- + +## Verify if Tree is already installed: + +- In your terminal, run: `tree --version` + - *If output is this version or higher:* + + - ``` bash + tree v2.0.2 (c) 1996 - 2022 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro + ``` + + - Continue to [next page](./6-ohmyzsh.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Installation + +**Run:** + + `brew install tree` + +Verify tree is installed by **running:** + + `tree --version` + +Expected Output: + +```bash +tree v1.8.0 (c) 1996 - 2018 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro +``` + +--- + +### [⇐ Previous](./4-git.md) | [Next ⇒](./6-ohmyzsh.md) diff --git a/system-setup/linux/6-ohmyzsh.md b/system-setup/linux/6-ohmyzsh.md new file mode 100644 index 0000000..be64ac8 --- /dev/null +++ b/system-setup/linux/6-ohmyzsh.md @@ -0,0 +1,37 @@ +# Oh-My-Zsh + +Now it's time to unleash your terminal potential. + +## Verify if Oh-My-Zsh is already installed + +- In your terminal, run: `zsh --version` + - *If output is this version or higher*: + - `zsh 5.8` + - Continue to [next page](./7-node.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Installation + +The following is pulled from [Oh My Zsh.](https://ohmyz.sh/) + +Run the following command in your termainl. + +`sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` + +> **NOTE:** You may get a questions asking if you want to update your terminal to `zsh`. Say `yes` to this. If any warnings or errors occur, be sure to complete what is being suggested or get help. + +At this point you `must` restart your terminal. + +## Bookmark + +Bookmark these site to reference later through other classes as needed. + +Lots of customization avaliable on their [github repo.](https://github.com/ohmyzsh/ohmyzsh/) + +This is a link to a [cheatsheet.](https://github.com/ohmyzsh/ohmyzsh/wiki/Cheatsheet) + +--- + +### [⇐ Previous](./5-tree.md) | [Next ⇒](./7-node.md) diff --git a/system-setup/linux/7-node.md b/system-setup/linux/7-node.md new file mode 100644 index 0000000..54c7a85 --- /dev/null +++ b/system-setup/linux/7-node.md @@ -0,0 +1,42 @@ +# Install Node Tools + +In this step, we'll install Node.js. + +## Verify if Node is already installed + +- In your terminal, run: `node --version` + - *If output is this version or higher*: + - `v17.8.0` + - Continue to [next page](./8-live-server.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Install Node + +**Run:** + +`brew install node` + +It will take a minute for the download and installation process to complete. + +Once it completes, ***you will need to exit*** your terminal, and log back in to demonstrate that the command works in a new shell. + +- Verify your node version by running this: + - `node --version` + - Your output should be similar to this: + `v17.8.0` + +- Verify that Node.js works ... + - Run the command: `node` + - Type `5 + 5` and hit `enter` + - The result should be `10`. If you get `11` your computer is broken. ;) + - **Quit** node by pressing **control C** two times. + +Did you get similar output for both? + +If not ... [head here](../../error/error.md) + +--- + +### [⇐ Previous](./6-ohmyzsh.md) | [Next ⇒](./8-live-server.md) diff --git a/system-setup/linux/8-live-server.md b/system-setup/linux/8-live-server.md new file mode 100644 index 0000000..c687e72 --- /dev/null +++ b/system-setup/linux/8-live-server.md @@ -0,0 +1,31 @@ +# live-server + +This is a simulated website development server with live reload capability. This will allow you to see your website before deoploying. + +## Verify if live-server is already installed + +- In your terminal, run: `live-server --version` + - *If output is this version or higher*: + - `live-server 1.2.1` + - Continue to [next page](./9-eslint.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Installation + +**Run:** + + `npm install -g live-server` + +Verify live-server is installed by **running:** + + `live-server --version` + +Expected Output: + +`live-server 1.2.1` + +--- + +### [⇐ Previous](./7-node.md) | | [Next ⇒](./9-eslint.md) diff --git a/system-setup/linux/9-eslint.md b/system-setup/linux/9-eslint.md new file mode 100644 index 0000000..a55bf0a --- /dev/null +++ b/system-setup/linux/9-eslint.md @@ -0,0 +1,53 @@ +# ESLint and Folder Structure + +## Verify if ESLint is already installed + +- In your terminal, run: `eslint --version` + - *If output is this version or higher*: + - `v6.7.2` + - Continue to [next page](./10-vscode.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Install ESLint + +**Run:** + +`npm install -g eslint` + +You should see a lot of feedback as it installs. + +After it has completed, **run:** + +`eslint --version` + +You should see something similar: + +```bash +v6.7.2 +``` + +## Folder Structure + +Can you predict what these commands will do? + +Type each of the following commands, one line at a time, to create a folder structure where you will store code on your computer: + +```bash +cd ~ +mkdir projects +cd projects +mkdir courses +cd courses +pwd +``` + +You should see an output similar to this: +`/home/your_user_name/projects/courses` + +This is the place to clone repositories for labs + +--- + +### [⇐ Previous](./8-live-server.md) | | [Next ⇒](./10-vscode.md) diff --git a/system-setup/linux/README.md b/system-setup/linux/README.md new file mode 100644 index 0000000..97f6f22 --- /dev/null +++ b/system-setup/linux/README.md @@ -0,0 +1,9 @@ +# Setting up your development environment + +The next series of steps will walk you through getting your system setup with the proper applications and settings. These steps will be the same for all systems (Windows, Mac, or Linux) except where noted. + +**OPEN YOUR TERMINAL** and let's get started! + +--- + +### [⇐ Previous](../../README.md) | [Next ⇒](./1-environment.md) diff --git a/system-setup/mac/1-environment.md b/system-setup/mac/1-environment.md new file mode 100644 index 0000000..c465401 --- /dev/null +++ b/system-setup/mac/1-environment.md @@ -0,0 +1,26 @@ +# Backup Your Terminal/Shell Environment + +This section will talk about how to update the Terminal's look and feel, as well as how to edit files using the command line editor, `nano` + +At the end of this guide, we will add some color to your command line, and your command line will be formatted for development. + +## Backing up files + +The first thing we'll do is backup your existing terminal setup. + +There are a lot of ways that your terminal can be set up determined by different configuration files. + +We want to remove the old ways so we can start with a clean slate. + +Make back ups of the files listed below. You may get a `No such file or directory` error for some of them. That's ok. + +- `mv ~/.bashrc .bashrc.bak` +- `mv ~/.bash_profile .bash_profile.bak` +- `mv ~/.profile .profile.bak` +- `mv ~/.zshrc .zshrc.bak` + +Now, let's move on to getting our development applications installed. + +--- + +### [⇐ Previous](./README.md) | [Next ⇒](./2-homebrew.md) diff --git a/system-setup/mac/10-verify.md b/system-setup/mac/10-verify.md new file mode 100644 index 0000000..5510b37 --- /dev/null +++ b/system-setup/mac/10-verify.md @@ -0,0 +1,38 @@ +# Verify Your Setup Part 1 + +> By the time you’ve completed the guide, you should be able to run the following commands in your terminal and see the expected output. Your versions may be slightly different than what is listed here due to recent updates. + +- `code --version` + - `1.64.2` +- `git --version` + - `git version 2.34.1` +- `node --version` + - `v17.31.1` +- `npm --version` + - `8.3.0` +- `eslint --version` + - `v8.1.0` +- `tree --version` + - `tree v2.0.1 (c) 1996 - 2018 ...` +- `git config --list` should contain at least the following: + - `user.name=YOUR NAME` + - `user.email=YOUR EMAIL` + - `core.editor=code --wait` + - `init.defaultbranch=main` + - Type the letter `q` to exit the config screen and return to the previous screen. +- `code .` + - should open VS Code with your current folder contents + +## Verify Your Setup Part 2 + +Run the following command + +```bash +curl -Ls https://bit.ly/3qMWhbE | bash +``` + +You should get a successful message. If you do not see `By gum, you've done it!`, look at the output from the steps in part 1 to begin troubleshooting. Get TA assistance as necessary. + +--- + +### That's It! [Back To the Beginning](../../README.md) diff --git a/system-setup/mac/2-homebrew.md b/system-setup/mac/2-homebrew.md new file mode 100644 index 0000000..d41d434 --- /dev/null +++ b/system-setup/mac/2-homebrew.md @@ -0,0 +1,63 @@ +# Install "Homebrew" + +Homebrew is a tool that simplifies installing applications on your machine. Think of it like an app store for your computer. + +--- + +## Verify if Homebrew is already installed + +- In your terminal, run: `brew --version` + - *If output is similar to:* `Homebrew 3.4.11` + - Run: `brew update` to get latest updates + - Move on to [next page](./3-git.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +In your terminal, enter the following command: + +- `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` + +- You will be prompted several times along the way. Enter your password when prompted, accept all the defaults, say "Yes" if prompted. (***Note:*** *You will not have any visual feedback on your screen as you type. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes.*) + +- You will likely be prompted to install XCode command line tools. Say "Yes". + +- When it completes, follow the "Next steps:" instructions displayed in your terminal, which should be similar to: + - ```echo 'eval "$(`which brew` shellenv)"' >> $HOME/.zprofile``` + - ```eval "$(`which brew` shellenv)"``` + +Once the installation has completed, **run:** + +- `brew doctor` + +**if** return output is: + +```bash +Your system is ready to brew +``` + +**or** return output is: + +```text +Please note that these warnings are just used to help the Homebrew maintainers +with debugging if you file an issue. If everything you use Homebrew for is +working fine: please don't worry or file an issue; just ignore this. Thanks! +``` + +**then run:** + +- `brew update` + +**else if** return output is: + +```bash +brew: command not found +``` + +> **Then [Click here](../../error/error.md) and do not continue with the following steps until you have Homebrew properly installed** + +When that completes, you will be returned to the command prompt and can move on to the next steps. + +--- + +### [⇐ Previous](./1-environment.md) | [Next ⇒](./3-git.md) diff --git a/system-setup/mac/3-git.md b/system-setup/mac/3-git.md new file mode 100644 index 0000000..abb55f3 --- /dev/null +++ b/system-setup/mac/3-git.md @@ -0,0 +1,68 @@ +# Git + +## Verify if Git & GitHub are already installed: + +- In your terminal, run: `git config --list` +- **Note**: To exit the git config --list screen, type the letter `q` in your terminal + - *If the output is similar to:* + + - ```bash + user.name=[Your name is here] + user.email=[Your email is here] + code.editor=code --wait + init.defaultbranch=main + ``` + + - Then move on to [next page](./4-tree.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Install and Configure Git and GitHub + +Run the following command to ensure that you have the most recent version of git: + +`brew install git || brew upgrade git` + +## Setup GitHub for "Authentication" + +In order to use Git locally in a secure manner, we need to connect our computer with github.com. + +[GitHub Instructions: Caching GitHub credentials](https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git) + +- Install CLI by completing the following steps: + - run in terminal: `brew install gh` + - run in terminal: `gh auth login` + - Use arrow key to select **GitHub.com** + - Select **HTTPS** + - When prompted with Authenticate Git with your GitHub credentials (Y / n). Press `y` and enter + - Click **Login with a web browser** + - Copy the one time code shown in yout terminal and then press enter. This will open github.com in a web page. + - If not signed in, you will be prompted to signin. + - Github will prompt you for the one time code. Enter in the appropriate boxes. + - Click **Authorize github** + - You can close the web browser and press enter in your terminal to continue. + +## Git Config + +Like artists, programmers sign their work. Let's configure Git to sign your commits with your name and email address. + +**WARNING:** Before running the following commands one line at at time, replace `YOUR FULL NAME` and `YOUR EMAIL ADDRESS` with the name and email from [Your GitHub Account](https://github.com/settings/profile) + +```bash +git config --global user.name 'YOUR FULL NAME' +``` + +```bash +git config --global user.email 'YOUR EMAIL ADDRESS' +``` + +```bash +git config --global core.editor "code --wait" +``` + +```bash +git config --global init.defaultbranch main +``` + +### [⇐ Previous](./2-homebrew.md) | [Next ⇒](./4-tree.md) diff --git a/system-setup/mac/4-tree.md b/system-setup/mac/4-tree.md new file mode 100644 index 0000000..fc0f0ff --- /dev/null +++ b/system-setup/mac/4-tree.md @@ -0,0 +1,46 @@ +# Tree + +Tree is a useful application that will allow you to look at a directory structure and files that are in a directory. + +```text +# Example of what an output may look like +── courses + ├── code102 + ├── code201 +``` + +--- + +## Verify if Tree is already installed: + +- In your terminal, run: `tree --version` + - *If output is this version or higher:* + + - ``` bash + tree v2.0.2 (c) 1996 - 2022 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro + ``` + + - Continue to [next page](./5-ohmyzsh.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Installation + +**Run:** + + `brew install tree` + +Verify tree is installed by **running:** + + `tree --version` + +Expected Output: + +```bash +tree v1.8.0 (c) 1996 - 2018 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro +``` + +--- + +### [⇐ Previous](./3-git.md) | [Next ⇒](./5-ohmyzsh.md) diff --git a/system-setup/mac/5-ohmyzsh.md b/system-setup/mac/5-ohmyzsh.md new file mode 100644 index 0000000..d1bf7d5 --- /dev/null +++ b/system-setup/mac/5-ohmyzsh.md @@ -0,0 +1,37 @@ +# Oh-My-Zsh + +Now it's time to unleash your terminal potential. + +## Verify if Oh-My-Zsh is already installed + +- In your terminal, run: `zsh --version` + - *If output is this version or higher*: + - `zsh 5.8` + - Continue to [next page](./6-node.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Installation + +The following is pulled from [Oh My Zsh.](https://ohmyz.sh/) + +Run the following command in your termainl. + +`sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` + +> **NOTE:** You may get a questions asking if you want to update your terminal to `zsh`. Say `yes` to this. If any warnings or errors occur, be sure to complete what is being suggested or get help. + +At this point you `must` restart your terminal. + +## Bookmark + +Bookmark these site to reference later through other classes as needed. + +Lots of customization avaliable on their [github repo.](https://github.com/ohmyzsh/ohmyzsh/) + +This is a link to a [cheatsheet.](https://github.com/ohmyzsh/ohmyzsh/wiki/Cheatsheet) + +--- + +### [⇐ Previous](./4-tree.md) | [Next ⇒](./6-node.md) diff --git a/system-setup/mac/6-node.md b/system-setup/mac/6-node.md new file mode 100644 index 0000000..dda7244 --- /dev/null +++ b/system-setup/mac/6-node.md @@ -0,0 +1,42 @@ +# Install Node Tools + +In this step, we'll install Node.js. + +## Verify if Node is already installed + +- In your terminal, run: `node --version` + - *If output is this version or higher*: + - `v17.8.0` + - Continue to [next page](./7-live-server.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Install Node + +**Run:** + +`brew install node` + +It will take a minute for the download and installation process to complete. + +Once it completes, ***you will need to exit*** your terminal, and log back in to demonstrate that the command works in a new shell. + +- Verify your node version by running this: + - `node --version` + - Your output should be similar to this: + `v17.8.0` + +- Verify that Node.js works ... + - Run the command: `node` + - Type `5 + 5` and hit `enter` + - The result should be `10`. If you get `11` your computer is broken. ;) + - **Quit** node by pressing **control C** two times. + +Did you get similar output for both? + +If not ... [head here](../../error/error.md) + +--- + +### [⇐ Previous](./5-ohmyzsh.md) | [Next ⇒](./7-live-server.md) diff --git a/system-setup/mac/7-live-server.md b/system-setup/mac/7-live-server.md new file mode 100644 index 0000000..3497532 --- /dev/null +++ b/system-setup/mac/7-live-server.md @@ -0,0 +1,31 @@ +# live-server + +This is a simulated website development server with live reload capability. This will allow you to see your website before deoploying. + +## Verify if live-server is already installed + +- In your terminal, run: `live-server --version` + - *If output is this version or higher*: + - `live-server 1.2.1` + - Continue to [next page](./8-eslint.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Installation + +**Run:** + + `npm install -g live-server` + +Verify live-server is installed by **running:** + + `live-server --version` + +Expected Output: + +`live-server 1.2.1` + +--- + +### [⇐ Previous](./6-node.md) | | [Next ⇒](./8-eslint.md) diff --git a/system-setup/mac/8-eslint.md b/system-setup/mac/8-eslint.md new file mode 100644 index 0000000..3ff41c4 --- /dev/null +++ b/system-setup/mac/8-eslint.md @@ -0,0 +1,53 @@ +# ESLint and Folder Structure + +## Verify if ESLint is already installed + +- In your terminal, run: `eslint --version` + - *If output is this version or higher*: + - `v6.7.2` + - Continue to [next page](./9-vscode.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Install ESLint + +**Run:** + +`npm install -g eslint` + +You should see a lot of feedback as it installs. + +After it has completed, **run:** + +`eslint --version` + +You should see something similar: + +```bash +v6.7.2 +``` + +## Folder Structure + +Can you predict what these commands will do? + +Type each of the following commands, one line at a time, to create a folder structure where you will store code on your computer: + +```bash +cd ~ +mkdir projects +cd projects +mkdir courses +cd courses +pwd +``` + +You should see an output similar to this: +`/home/your_user_name/projects/courses` + +This is the place to clone repositories for labs + +--- + +### [⇐ Previous](./7-live-server.md) | | [Next ⇒](./9-vscode.md) diff --git a/system-setup/mac/9-vscode.md b/system-setup/mac/9-vscode.md new file mode 100644 index 0000000..11f74d8 --- /dev/null +++ b/system-setup/mac/9-vscode.md @@ -0,0 +1,40 @@ +# Install VSCode Text Editor + +Now it's time to install VSCode Text Editor, a sophisticated text editor for code, markup, and prose. + +> **Follow the below instructions in order** + +## Get Started + +- Close any open terminal windows. +- Download [VSCode](https://code.visualstudio.com/download) and install. + +- If this window displays during set up, be sure the following boxes are selected +![VSCode](../vscode.png) +- Before launching the application, move VSCode from your downloads folder to your applications folder. +- Launch The VS Code Application +- Open the **Command Palette** (⌘⇧P) and type 'shell command' +- Click the **Shell Command: Install 'code' command in PATH** command. + +## Install VSCode Extensions + +We'll now be adding some functionality to your new code editor by installing a number of extensions. + +- You can open VSCode through your terminal using `code .` +- On the bottom left hand side you will see a settings ("gear") icon. +- Click this, then click "Extensions". +- A side-bar will slide out and at the top you can search for the listed extensions below, and click the green 'Install' button for each: + - liveserver + - ESLint + - markdownlint + - editorconfig + - HTML Preview + - Thunder Client + +There are many other extensions to choose from that will make your coding life a lot easier. Your instructors, TAs and classmates will all be great resources as to what works well for them. + +[VSCode's documentation](https://code.visualstudio.com/docs) is excellent. Review it now to familiarize yourself with the basics. + +--- + +### [⇐ Previous](./8-eslint.md) | [Next ⇒](./10-verify.md) diff --git a/system-setup/mac/README.md b/system-setup/mac/README.md new file mode 100644 index 0000000..97f6f22 --- /dev/null +++ b/system-setup/mac/README.md @@ -0,0 +1,9 @@ +# Setting up your development environment + +The next series of steps will walk you through getting your system setup with the proper applications and settings. These steps will be the same for all systems (Windows, Mac, or Linux) except where noted. + +**OPEN YOUR TERMINAL** and let's get started! + +--- + +### [⇐ Previous](../../README.md) | [Next ⇒](./1-environment.md) diff --git a/system-setup/windows/1-environment.md b/system-setup/windows/1-environment.md new file mode 100644 index 0000000..1192727 --- /dev/null +++ b/system-setup/windows/1-environment.md @@ -0,0 +1,34 @@ +# Backup Your Terminal/Shell Environment + +This section will talk about how to update the Terminal's look and feel, as well as how to edit files using the command line editor, `nano` + +At the end of this guide, we will add some color to your command line, and your command line will be formatted for development. + +## Backing up files + +The first thing we'll do is backup your existing terminal setup. + +There are a lot of ways that your terminal can be set up determined by different configuration files. + +We want to remove the old ways so we can start with a clean slate. + +Make back ups of the files listed below. You may get a `No such file or directory` error for some of them. That's ok. + +- `mv ~/.bashrc .bashrc.bak` +- `mv ~/.bash_profile .bash_profile.bak` +- `mv ~/.profile .profile.bak` +- `mv ~/.zshrc .zshrc.bak` + +## Install Z Shell + +```bash +sudo apt-get install zsh +``` + +After installing, type `zsh`. Zsh will ask you to choose some configuration. We will do this later by installing `oh-my-zsh`. Chose option 0 to create the config file (prevent this message to show again). + +Now, let's move on to getting our development applications installed. + +--- + +### [⇐ Previous](./README.md) | [Next ⇒](./2-apt.md) diff --git a/system-setup/windows/10-vscode.md b/system-setup/windows/10-vscode.md new file mode 100644 index 0000000..0132846 --- /dev/null +++ b/system-setup/windows/10-vscode.md @@ -0,0 +1,49 @@ +# Install VSCode Text Editor + +Now it's time to install VSCode Text Editor, a sophisticated text editor for code, markup, and prose. + +> **Follow the below instructions in order**, paying attention to any notes specific to Windows or Mac, depending on your operating system. + +## Get Started + +- Close any open terminal windows. +- Download [VSCode](https://code.visualstudio.com/download) and install. + +### Windows Users + +- If this window displays during set up, be sure the following boxes are selected +![VSCode](../vscode.png) + +- Open VSCode +- Install the Remote WSL Extension. To do this: + - On the bottom left hand side you will see a settings ("gear") icon. + - Click this, then click "Extensions". + - A side-bar will slide out and at the top you can search for extensions. + - Click "install" on the extension you want. +- Close VSCode +- Re-open your terminal +- Run the following command in your terminal: + - `sudo apt-get install wget ca-certificates` +- Once that is complete, run the following command in your terminal to launch VSCode with Remote WSL: + - `code .` + +### Install Additional VSCode Extensions + +We'll now be adding some functionality to your new code editor! + +Install the following extensions: + +- liveserver +- ESLint +- markdownlint +- editorconfig +- HTML Preview +- Thunder Client + +There are many other extensions to choose from that will make your coding life a lot easier. Your instructors, TAs and classmates will all be great resources as to what works well for them. + +[VSCode's documentation](https://code.visualstudio.com/docs) is excellent. Review it now to familiarize yourself with the basics. + +--- + +### [⇐ Previous](./9-eslint.md) | [Next ⇒](./11-verify.md) diff --git a/system-setup/windows/11-verify.md b/system-setup/windows/11-verify.md new file mode 100644 index 0000000..5510b37 --- /dev/null +++ b/system-setup/windows/11-verify.md @@ -0,0 +1,38 @@ +# Verify Your Setup Part 1 + +> By the time you’ve completed the guide, you should be able to run the following commands in your terminal and see the expected output. Your versions may be slightly different than what is listed here due to recent updates. + +- `code --version` + - `1.64.2` +- `git --version` + - `git version 2.34.1` +- `node --version` + - `v17.31.1` +- `npm --version` + - `8.3.0` +- `eslint --version` + - `v8.1.0` +- `tree --version` + - `tree v2.0.1 (c) 1996 - 2018 ...` +- `git config --list` should contain at least the following: + - `user.name=YOUR NAME` + - `user.email=YOUR EMAIL` + - `core.editor=code --wait` + - `init.defaultbranch=main` + - Type the letter `q` to exit the config screen and return to the previous screen. +- `code .` + - should open VS Code with your current folder contents + +## Verify Your Setup Part 2 + +Run the following command + +```bash +curl -Ls https://bit.ly/3qMWhbE | bash +``` + +You should get a successful message. If you do not see `By gum, you've done it!`, look at the output from the steps in part 1 to begin troubleshooting. Get TA assistance as necessary. + +--- + +### That's It! [Back To the Beginning](../../README.md) diff --git a/system-setup/windows/2-apt.md b/system-setup/windows/2-apt.md new file mode 100644 index 0000000..934792c --- /dev/null +++ b/system-setup/windows/2-apt.md @@ -0,0 +1,15 @@ +# Installing and Updating the Linux App Manager + +For some things on your system, we will be using `apt` to install applications. The first thing we'll want to do is get that up to date with all of the latest versions and information + +**OPEN YOUR UBUNTU TERMINAL** and let's get started! + +1. Type `sudo apt-get update`. + - Provide your password, when prompted (***Note:*** *You will not have any visual feedback on your screen as you type. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes.*) +1. Once that is complete, type `sudo apt-get upgrade`. Press `y` when prompted. +1. Once that is done, type `sudo apt autoremove`. This will remove any packages that are no longer needed. +1. Install the "Build Essentials" kit with this command: `sudo apt-get install build-essential` + +--- + +### [⇐ Previous](./1-environment.md) | [Next ⇒](./3-homebrew.md) diff --git a/system-setup/windows/3-homebrew.md b/system-setup/windows/3-homebrew.md new file mode 100644 index 0000000..6e1f2e6 --- /dev/null +++ b/system-setup/windows/3-homebrew.md @@ -0,0 +1,74 @@ +# Install "Homebrew" + +Homebrew is a tool that simplifies installing applications on your machine. Think of it like an app store for your computer. + +--- + +## Verify if Homebrew is already installed + +- In your terminal, run: `brew --version` + - *If output is similar to:* `Homebrew 3.4.11` + - Run: `brew update` to get latest updates + - Move on to [next page](./4-git.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +In your terminal, enter the following command: + +- `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` +- You will be prompted several times along the way. Enter your password when prompted, accept all the defaults, say "Yes" if prompted. (***Note:*** *You will not have any visual feedback on your screen as you type. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes.*) +- Once the main installation finishes (could take up to 30 minutes), enter these commands, one at a time in your terminal - they should produce no errors, and do not produce success messages: + - `test -d ~/.linuxbrew && eval $(~/.linuxbrew/bin/brew shellenv)` + - `test -d /home/linuxbrew/.linuxbrew && eval $(/home/linuxbrew/.linuxbrew/bin/brew shellenv)` + +Once the installation has completed, **run:** + + `brew doctor` + +**if** return output is: + +```bash +Your system is ready to brew +``` + +**or** return output is: + +```text +Please note that these warnings are just used to help the Homebrew maintainers +with debugging if you file an issue. If everything you use Homebrew for is +working fine: please don't worry or file an issue; just ignore this. Thanks! +``` + +**then run:** + +`brew update` + +**else if** return output is: + +```bash +brew: command not found +``` + +**then** run these commands + +1. ```echo 'export BREW_HOME="/home/linuxbrew/.linuxbrew/bin"' >> $HOME/.zprofile``` +1. ```echo 'export PATH="$PATH:$BREW_HOME"' >> $HOME/.zprofile``` +1. ```reset``` + + +> **If `brew update` still fails to run, [click here](../../error/error.md) and do not continue with the following steps until you have Homebrew properly installed** + +## Install "gcc" + +In order for Homebrew to install other applications, it needs a tool called **gcc** to assist itself. + +Run this command in your terminal: + +`brew install gcc` + +When that completes, you will be returned to the command prompt and can move on to the next steps. + +--- + +### [⇐ Previous](./2-apt.md) | [Next ⇒](./4-git.md) diff --git a/system-setup/windows/4-git.md b/system-setup/windows/4-git.md new file mode 100644 index 0000000..95ffbf8 --- /dev/null +++ b/system-setup/windows/4-git.md @@ -0,0 +1,68 @@ +# Git + +## Verify if Git & GitHub are already installed: + +- In your terminal, run: `git config --list` +- **Note**: To exit the git config --list screen, type the letter `q` in your terminal + - *If the output is similar to:* + + - ```bash + user.name=[Your name is here] + user.email=[Your email is here] + code.editor=code --wait + init.defaultbranch=main + ``` + + - Then move on to [next page](./5-tree.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Install and Configure Git and GitHub + +Run the following command to ensure that you have the most recent version of git: + +`brew install git || brew upgrade git` + +## Setup GitHub for "Authentication" + +In order to use Git locally in a secure manner, we need to connect our computer with github.com. + +[GitHub Instructions: Caching GitHub credentials](https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git) + +- Install CLI by completing the following steps: + - run in terminal: `brew install gh` + - run in terminal: `gh auth login` + - Use arrow key to select **GitHub.com** + - Select **HTTPS** + - When prompted with Authenticate Git with your GitHub credentials (Y / n). Press `y` and enter + - Click **Login with a web browser** + - Copy the one time code shown in yout terminal and then press enter. This will open github.com in a web page. + - If not signed in, you will be prompted to signin. + - Github will prompt you for the one time code. Enter in the appropriate boxes. + - Click **Authorize github** + - You can close the web browser and press enter in your terminal to continue. + +## Git Config + +Like artists, programmers sign their work. Let's configure Git to sign your commits with your name and email address. + +**WARNING:** Before running the following commands one line at at time, replace `YOUR FULL NAME` and `YOUR EMAIL ADDRESS` with the name and email from [Your GitHub Account](https://github.com/settings/profile) + +```bash +git config --global user.name 'YOUR FULL NAME' +``` + +```bash +git config --global user.email 'YOUR EMAIL ADDRESS' +``` + +```bash +git config --global core.editor "code --wait" +``` + +```bash +git config --global init.defaultbranch main +``` + +### [⇐ Previous](./3-homebrew.md) | [Next ⇒](./5-tree.md) diff --git a/system-setup/windows/5-tree.md b/system-setup/windows/5-tree.md new file mode 100644 index 0000000..ccd0315 --- /dev/null +++ b/system-setup/windows/5-tree.md @@ -0,0 +1,46 @@ +# Tree + +Tree is a useful application that will allow you to look at a directory structure and files that are in a directory. + +```text +# Example of what an output may look like +── courses + ├── code102 + ├── code201 +``` + +--- + +## Verify if Tree is already installed: + +- In your terminal, run: `tree --version` + - *If output is this version or higher:* + + - ``` bash + tree v2.0.2 (c) 1996 - 2022 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro + ``` + + - Continue to [next page](./6-ohmyzsh.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Installation + +**Run:** + + `brew install tree` + +Verify tree is installed by **running:** + + `tree --version` + +Expected Output: + +```bash +tree v1.8.0 (c) 1996 - 2018 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro +``` + +--- + +### [⇐ Previous](./4-git.md) | [Next ⇒](./6-ohmyzsh.md) diff --git a/system-setup/windows/6-ohmyzsh.md b/system-setup/windows/6-ohmyzsh.md new file mode 100644 index 0000000..be64ac8 --- /dev/null +++ b/system-setup/windows/6-ohmyzsh.md @@ -0,0 +1,37 @@ +# Oh-My-Zsh + +Now it's time to unleash your terminal potential. + +## Verify if Oh-My-Zsh is already installed + +- In your terminal, run: `zsh --version` + - *If output is this version or higher*: + - `zsh 5.8` + - Continue to [next page](./7-node.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Installation + +The following is pulled from [Oh My Zsh.](https://ohmyz.sh/) + +Run the following command in your termainl. + +`sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` + +> **NOTE:** You may get a questions asking if you want to update your terminal to `zsh`. Say `yes` to this. If any warnings or errors occur, be sure to complete what is being suggested or get help. + +At this point you `must` restart your terminal. + +## Bookmark + +Bookmark these site to reference later through other classes as needed. + +Lots of customization avaliable on their [github repo.](https://github.com/ohmyzsh/ohmyzsh/) + +This is a link to a [cheatsheet.](https://github.com/ohmyzsh/ohmyzsh/wiki/Cheatsheet) + +--- + +### [⇐ Previous](./5-tree.md) | [Next ⇒](./7-node.md) diff --git a/system-setup/windows/7-node.md b/system-setup/windows/7-node.md new file mode 100644 index 0000000..54c7a85 --- /dev/null +++ b/system-setup/windows/7-node.md @@ -0,0 +1,42 @@ +# Install Node Tools + +In this step, we'll install Node.js. + +## Verify if Node is already installed + +- In your terminal, run: `node --version` + - *If output is this version or higher*: + - `v17.8.0` + - Continue to [next page](./8-live-server.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Install Node + +**Run:** + +`brew install node` + +It will take a minute for the download and installation process to complete. + +Once it completes, ***you will need to exit*** your terminal, and log back in to demonstrate that the command works in a new shell. + +- Verify your node version by running this: + - `node --version` + - Your output should be similar to this: + `v17.8.0` + +- Verify that Node.js works ... + - Run the command: `node` + - Type `5 + 5` and hit `enter` + - The result should be `10`. If you get `11` your computer is broken. ;) + - **Quit** node by pressing **control C** two times. + +Did you get similar output for both? + +If not ... [head here](../../error/error.md) + +--- + +### [⇐ Previous](./6-ohmyzsh.md) | [Next ⇒](./8-live-server.md) diff --git a/system-setup/windows/8-live-server.md b/system-setup/windows/8-live-server.md new file mode 100644 index 0000000..c687e72 --- /dev/null +++ b/system-setup/windows/8-live-server.md @@ -0,0 +1,31 @@ +# live-server + +This is a simulated website development server with live reload capability. This will allow you to see your website before deoploying. + +## Verify if live-server is already installed + +- In your terminal, run: `live-server --version` + - *If output is this version or higher*: + - `live-server 1.2.1` + - Continue to [next page](./9-eslint.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Installation + +**Run:** + + `npm install -g live-server` + +Verify live-server is installed by **running:** + + `live-server --version` + +Expected Output: + +`live-server 1.2.1` + +--- + +### [⇐ Previous](./7-node.md) | | [Next ⇒](./9-eslint.md) diff --git a/system-setup/windows/9-eslint.md b/system-setup/windows/9-eslint.md new file mode 100644 index 0000000..a55bf0a --- /dev/null +++ b/system-setup/windows/9-eslint.md @@ -0,0 +1,53 @@ +# ESLint and Folder Structure + +## Verify if ESLint is already installed + +- In your terminal, run: `eslint --version` + - *If output is this version or higher*: + - `v6.7.2` + - Continue to [next page](./10-vscode.md) + - *If output is not similar to the above*, continue with instructions on this page. + +--- + +## Install ESLint + +**Run:** + +`npm install -g eslint` + +You should see a lot of feedback as it installs. + +After it has completed, **run:** + +`eslint --version` + +You should see something similar: + +```bash +v6.7.2 +``` + +## Folder Structure + +Can you predict what these commands will do? + +Type each of the following commands, one line at a time, to create a folder structure where you will store code on your computer: + +```bash +cd ~ +mkdir projects +cd projects +mkdir courses +cd courses +pwd +``` + +You should see an output similar to this: +`/home/your_user_name/projects/courses` + +This is the place to clone repositories for labs + +--- + +### [⇐ Previous](./8-live-server.md) | | [Next ⇒](./10-vscode.md) diff --git a/system-setup/windows/README.md b/system-setup/windows/README.md new file mode 100644 index 0000000..97f6f22 --- /dev/null +++ b/system-setup/windows/README.md @@ -0,0 +1,9 @@ +# Setting up your development environment + +The next series of steps will walk you through getting your system setup with the proper applications and settings. These steps will be the same for all systems (Windows, Mac, or Linux) except where noted. + +**OPEN YOUR TERMINAL** and let's get started! + +--- + +### [⇐ Previous](../../README.md) | [Next ⇒](./1-environment.md) diff --git a/windows/powershell.png b/system-setup/windows/powershell.png similarity index 100% rename from windows/powershell.png rename to system-setup/windows/powershell.png diff --git a/windows/windows-10.md b/system-setup/windows/windows-10.md similarity index 91% rename from windows/windows-10.md rename to system-setup/windows/windows-10.md index 0eaae1d..8466b79 100644 --- a/windows/windows-10.md +++ b/system-setup/windows/windows-10.md @@ -22,11 +22,11 @@ Check your windows version in settings before moving on. Click in the Windows Se ![Check the Build of your OS](https://p57.p1.n0.cdn.getcloudapp.com/items/4gujyKoO/Image%202020-06-15%20at%204.13.25%20PM.png?v=5b8a750ada301268081beb4e33d37077) -If your version is not a build higher than 19041, you'll need to do an update of Windows. [Open this page](https://www.microsoft.com/en-us/software-download/windows10){:target="_blank"}, and click the button that says "Download tool now". Run it, and allow it to update your current system's OS. This may take awhile. +If your version is not a build higher than 19041, you'll need to do an update of Windows. [Open this page](https://www.microsoft.com/en-us/software-download/windows10), and click the button that says "Download tool now". Run it, and allow it to update your current system's OS. This may take awhile. ### Enable WSL Feature in Windows -> **NOTE**: The following instructions are summarized from the [Microsoft WSL2 Upgrade Documentation](https://docs.microsoft.com/en-us/windows/wsl/install-win10#update-to-wsl-2){:target="_blank"} +> **NOTE**: The following instructions are summarized from the [Microsoft WSL2 Upgrade Documentation](https://docs.microsoft.com/en-us/windows/wsl/install-win10#update-to-wsl-2) 1. In the Search box next to the Windows Menu, type `Turn Windows Features On Or Off` and hit enter. 1. A window will pop up with a list of folders with checkboxes next to them. @@ -57,7 +57,7 @@ CAREFULLY read the output you get from running that command. Click the output th -You must update WSL a little further. [Open this page](https://aka.ms/wsl2kernel){:target="_blank"}, and follow the instructions. When you finish with those instructions, try running the above command again. +You must update WSL a little further. [Open this page](https://aka.ms/wsl2kernel), and follow the instructions. When you finish with those instructions, try running the above command again. @@ -74,12 +74,12 @@ Your system is all set, proceed with the following instructions here. ### Install the Ubuntu app from the Windows Store -1. Open the Microsoft Store and install the "Ubuntu" App with no version numbers(preferred), or latest version based on options avaliable. If you can't find it, [view it online](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6?activetab=pivot:overviewtab){:target="_blank"}. +1. Open the Microsoft Store and install the "Ubuntu" App with no version numbers(preferred), or latest version based on options avaliable. If you can't find it, [view it online](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6?activetab=pivot:overviewtab). 1. When the app is ready, it will prompt you to **Launch**. Click the Launch button. This will start the Ubuntu installation. This installation only happens the first time the app is launched, as it's the actual Ubuntu OS installing and mounting to your Windows file system. Anytime you uninstall the app and reinstall it you will have to do this process again. Make sure to back up important data if you ever uninstall this app, as it is not preserved. NOTE: If the above installation fails: -1. Go [here](https://docs.microsoft.com/en-us/windows/wsl/install-manual){:target="_blank"}. +1. Go [here](https://docs.microsoft.com/en-us/windows/wsl/install-manual). 1. Select the proper version: "Ubuntu 20.04", a download of an `.appx` file will occur. 1. Run this file, and it will do the same thing as the "Get" from the Windows Store. @@ -122,7 +122,7 @@ NOTE: If neither of the above work, do this: Note: If you are having trouble getting Ubuntu-20.04 getting to version 2, follow the [Manual Installation Instructions](https://docs.microsoft.com/en-us/windows/wsl/install-manual#step-4---download-the-linux-kernel-update-package) from Microsoft. -> **TIP:** When we refer to "Terminal" throughout this guide, you should open Ubuntu Terminal application. +> **TIP:** From now on when we refer to "Terminal" throughout this guide, you should open your Ubuntu Terminal application. ### 4. Continue with this setup guide @@ -130,4 +130,4 @@ Once you have your system configured as above, you are ready to complete the req --- -### [Next ⇒](../system-setup/README.md) +### [⇐ Previous](../../README.md) | [Next ⇒](./README.md) diff --git a/windows/windows-11.md b/system-setup/windows/windows-11.md similarity index 88% rename from windows/windows-11.md rename to system-setup/windows/windows-11.md index 85413a0..30ed61b 100644 --- a/windows/windows-11.md +++ b/system-setup/windows/windows-11.md @@ -2,9 +2,9 @@ ## Overview -Windows has released a feature available to all PCs running on Windows 11 called Windows Subsystem for Linux, otherwise known as WSL. WSL gives you the ability to add a Linux distribution (aka "distro"), like Ubuntu Linux, and connect it directly to the Windows File System. +Windows has released a feature available to all PCs running on Windows 11 called Windows Subsystem for Linux, otherwise known as WSL. WSL gives you the ability to add a Linux distribution (aka "distro"), like Ubuntu Linux, and connect it directly to the Windows File System. -This guide will show you how to set up Ubuntu on your PC, and use it for software development. +This guide will show you how to set up Ubuntu on your PC, and use it for software development. ## Install Instructions @@ -20,11 +20,12 @@ For setting up a modern development environment on Windows 11, we will require t 1. Open Powershell on your computer with administrative access (right click on powershell and run as administrator). 2. Run the following command: + ```bash wsl --install ``` -3. You may be prompted to reboot your machine. +3. You may be prompted to reboot your machine. #### Verify that you are running WSL Version 2 @@ -44,7 +45,7 @@ For setting up a modern development environment on Windows 11, we will require t This will be found in your start menu. It's a good idea to "Right Click" it's icon from the task bar and "Pin" it for easier access in the future. -> **TIP:** When we refer to "Terminal" throughout this guide, you should open Ubuntu Terminal application. +> **TIP:** From now on when we refer to "Terminal" throughout this guide, you should open your Ubuntu Terminal application. ### 4. Continue with this setup guide @@ -52,4 +53,4 @@ Once you have your system configured as above, you are ready to complete the req --- -### [Next ⇒](../system-setup/README.md) +### [⇐ Previous](../../README.md) | [Next ⇒](./README.md)