Skip to content

Commit a45f645

Browse files
Split core setup guide by OS (#159)
* Created folder paths for each OS, duplicated setup steps in each * Removed Windows and Linux instructions from Mac path * Removed Mac instructions from Windows path * Removed Windows and Mac instructions from Linux path * Moved original files back to previous location
1 parent 26a1605 commit a45f645

39 files changed

+1445
-15
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@ Please follow the correct path below, based on the course that you are registere
1414

1515
### Begin by selecting your Operating System
1616

17-
18-
[MacOS](./system-setup/README.md) | [Ubuntu Linux](./system-setup/README.md) | [Windows 10](./windows/windows-10.md) | [Windows 11](./windows/windows-11.md)
19-
17+
[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)
2018

2119
## Path 2 - For students registered for `Ops-102`, `Ops-201`, `Ops-301`, or `Ops-401` only
2220

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Backup Your Terminal/Shell Environment
2+
3+
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`
4+
5+
At the end of this guide, we will add some color to your command line, and your command line will be formatted for development.
6+
7+
## Backing up files
8+
9+
The first thing we'll do is backup your existing terminal setup.
10+
11+
There are a lot of ways that your terminal can be set up determined by different configuration files.
12+
13+
We want to remove the old ways so we can start with a clean slate.
14+
15+
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.
16+
17+
- `mv ~/.bashrc .bashrc.bak`
18+
- `mv ~/.bash_profile .bash_profile.bak`
19+
- `mv ~/.profile .profile.bak`
20+
- `mv ~/.zshrc .zshrc.bak`
21+
22+
## Install Z Shell
23+
24+
```bash
25+
sudo apt-get install zsh
26+
```
27+
28+
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).
29+
30+
Now, let's move on to getting our development applications installed.
31+
32+
---
33+
34+
### [⇐ Previous](./README.md) | [Next ⇒](./2-apt.md)

system-setup/linux/10-vscode.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Install VSCode Text Editor
2+
3+
Now it's time to install VSCode Text Editor, a sophisticated text editor for code, markup, and prose.
4+
5+
> **Follow the below instructions in order**, paying attention to any notes specific to Windows or Mac, depending on your operating system.
6+
7+
## Get Started
8+
9+
- Close any open terminal windows.
10+
- Download [VSCode](https://code.visualstudio.com/download) and install.
11+
- If this window displays during set up, be sure the following boxes are selected
12+
![VSCode](../vscode.png)
13+
14+
### Install Additional VSCode Extensions
15+
16+
We'll now be adding some functionality to your new code editor by installing a number of extensions.
17+
18+
- You can open VSCode through your terminal using `code .`
19+
- On the bottom left hand side you will see a settings ("gear") icon.
20+
- Click this, then click "Extensions".
21+
- 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:
22+
- liveserver
23+
- ESLint
24+
- markdownlint
25+
- editorconfig
26+
- HTML Preview
27+
- Thunder Client
28+
29+
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.
30+
31+
[VSCode's documentation](https://code.visualstudio.com/docs) is excellent. Review it now to familiarize yourself with the basics.
32+
33+
---
34+
35+
### [⇐ Previous](./9-eslint.md) | [Next ⇒](./11-verify.md)

system-setup/linux/11-verify.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Verify Your Setup Part 1
2+
3+
> 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.
4+
5+
- `code --version`
6+
- `1.64.2`
7+
- `git --version`
8+
- `git version 2.34.1`
9+
- `node --version`
10+
- `v17.31.1`
11+
- `npm --version`
12+
- `8.3.0`
13+
- `eslint --version`
14+
- `v8.1.0`
15+
- `tree --version`
16+
- `tree v2.0.1 (c) 1996 - 2018 ...`
17+
- `git config --list` should contain at least the following:
18+
- `user.name=YOUR NAME`
19+
- `user.email=YOUR EMAIL`
20+
- `core.editor=code --wait`
21+
- `init.defaultbranch=main`
22+
- Type the letter `q` to exit the config screen and return to the previous screen.
23+
- `code .`
24+
- should open VS Code with your current folder contents
25+
26+
## Verify Your Setup Part 2
27+
28+
Run the following command
29+
30+
```bash
31+
curl -Ls https://bit.ly/3qMWhbE | bash
32+
```
33+
34+
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.
35+
36+
---
37+
38+
### That's It! [Back To the Beginning](../../README.md)

system-setup/linux/2-apt.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Installing and Updating the Linux App Manager
2+
3+
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
4+
5+
**OPEN YOUR UBUNTU TERMINAL** and let's get started!
6+
7+
1. Type `sudo apt-get update`.
8+
- 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.*)
9+
1. Once that is complete, type `sudo apt-get upgrade`. Press `y` when prompted.
10+
1. Once that is done, type `sudo apt autoremove`. This will remove any packages that are no longer needed.
11+
1. Install the "Build Essentials" kit with this command: `sudo apt-get install build-essential`
12+
13+
---
14+
15+
### [⇐ Previous](./1-environment.md) | [Next ⇒](./3-homebrew.md)

system-setup/linux/3-homebrew.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Install "Homebrew"
2+
3+
Homebrew is a tool that simplifies installing applications on your machine. Think of it like an app store for your computer.
4+
5+
---
6+
7+
## Verify if Homebrew is already installed
8+
9+
- In your terminal, run: `brew --version`
10+
- *If output is similar to:* `Homebrew 3.4.11`
11+
- Run: `brew update` to get latest updates
12+
- Move on to [next page](./4-git.md)
13+
- *If output is not similar to the above*, continue with instructions on this page.
14+
15+
---
16+
17+
In your terminal, enter the following command:
18+
19+
- `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
20+
- 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.*)
21+
- 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:
22+
- `test -d ~/.linuxbrew && eval $(~/.linuxbrew/bin/brew shellenv)`
23+
- `test -d /home/linuxbrew/.linuxbrew && eval $(/home/linuxbrew/.linuxbrew/bin/brew shellenv)`
24+
25+
Once the installation has completed, **run:**
26+
27+
`brew doctor`
28+
29+
**if** return output is:
30+
31+
```bash
32+
Your system is ready to brew
33+
```
34+
35+
**or** return output is:
36+
37+
```text
38+
Please note that these warnings are just used to help the Homebrew maintainers
39+
with debugging if you file an issue. If everything you use Homebrew for is
40+
working fine: please don't worry or file an issue; just ignore this. Thanks!
41+
```
42+
43+
**then run:**
44+
45+
`brew update`
46+
47+
**else if** return output is:
48+
49+
```bash
50+
brew: command not found
51+
```
52+
53+
**then** run these commands
54+
55+
1. ```echo 'export BREW_HOME="/home/linuxbrew/.linuxbrew/bin"' >> $HOME/.zprofile```
56+
1. ```echo 'export PATH="$PATH:$BREW_HOME"' >> $HOME/.zprofile```
57+
1. ```reset```
58+
59+
60+
> **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**
61+
62+
## Install "gcc"
63+
64+
In order for Homebrew to install other applications, it needs a tool called **gcc** to assist itself.
65+
66+
Run this command in your terminal:
67+
68+
`brew install gcc`
69+
70+
When that completes, you will be returned to the command prompt and can move on to the next steps.
71+
72+
---
73+
74+
### [⇐ Previous](./2-apt.md) | [Next ⇒](./4-git.md)

system-setup/linux/4-git.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Git
2+
3+
## Verify if Git & GitHub are already installed:
4+
5+
- In your terminal, run: `git config --list`
6+
- **Note**: To exit the git config --list screen, type the letter `q` in your terminal
7+
- *If the output is similar to:*
8+
9+
- ```bash
10+
user.name=[Your name is here]
11+
user.email=[Your email is here]
12+
code.editor=code --wait
13+
init.defaultbranch=main
14+
```
15+
16+
- Then move on to [next page](./5-tree.md)
17+
- *If output is not similar to the above*, continue with instructions on this page.
18+
19+
---
20+
21+
## Install and Configure Git and GitHub
22+
23+
Run the following command to ensure that you have the most recent version of git:
24+
25+
`brew install git || brew upgrade git`
26+
27+
## Setup GitHub for "Authentication"
28+
29+
In order to use Git locally in a secure manner, we need to connect our computer with github.com.
30+
31+
[GitHub Instructions: Caching GitHub credentials](https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git)
32+
33+
- Install CLI by completing the following steps:
34+
- run in terminal: `brew install gh`
35+
- run in terminal: `gh auth login`
36+
- Use arrow key to select **GitHub.com**
37+
- Select **HTTPS**
38+
- When prompted with Authenticate Git with your GitHub credentials (Y / n). Press `y` and enter
39+
- Click **Login with a web browser**
40+
- Copy the one time code shown in yout terminal and then press enter. This will open github.com in a web page.
41+
- If not signed in, you will be prompted to signin.
42+
- Github will prompt you for the one time code. Enter in the appropriate boxes.
43+
- Click **Authorize github**
44+
- You can close the web browser and press enter in your terminal to continue.
45+
46+
## Git Config
47+
48+
Like artists, programmers sign their work. Let's configure Git to sign your commits with your name and email address.
49+
50+
**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)
51+
52+
```bash
53+
git config --global user.name 'YOUR FULL NAME'
54+
```
55+
56+
```bash
57+
git config --global user.email 'YOUR EMAIL ADDRESS'
58+
```
59+
60+
```bash
61+
git config --global core.editor "code --wait"
62+
```
63+
64+
```bash
65+
git config --global init.defaultbranch main
66+
```
67+
68+
### [⇐ Previous](./3-homebrew.md) | [Next ⇒](./5-tree.md)

system-setup/linux/5-tree.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Tree
2+
3+
Tree is a useful application that will allow you to look at a directory structure and files that are in a directory.
4+
5+
```text
6+
# Example of what an output may look like
7+
── courses
8+
├── code102
9+
├── code201
10+
```
11+
12+
---
13+
14+
## Verify if Tree is already installed:
15+
16+
- In your terminal, run: `tree --version`
17+
- *If output is this version or higher:*
18+
19+
- ``` bash
20+
tree v2.0.2 (c) 1996 - 2022 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro
21+
```
22+
23+
- Continue to [next page](./6-ohmyzsh.md)
24+
- *If output is not similar to the above*, continue with instructions on this page.
25+
26+
---
27+
28+
## Installation
29+
30+
**Run:**
31+
32+
`brew install tree`
33+
34+
Verify tree is installed by **running:**
35+
36+
`tree --version`
37+
38+
Expected Output:
39+
40+
```bash
41+
tree v1.8.0 (c) 1996 - 2018 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro
42+
```
43+
44+
---
45+
46+
### [⇐ Previous](./4-git.md) | [Next ⇒](./6-ohmyzsh.md)

system-setup/linux/6-ohmyzsh.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Oh-My-Zsh
2+
3+
Now it's time to unleash your terminal potential.
4+
5+
## Verify if Oh-My-Zsh is already installed
6+
7+
- In your terminal, run: `zsh --version`
8+
- *If output is this version or higher*:
9+
- `zsh 5.8`
10+
- Continue to [next page](./7-node.md)
11+
- *If output is not similar to the above*, continue with instructions on this page.
12+
13+
---
14+
15+
## Installation
16+
17+
The following is pulled from [Oh My Zsh.](https://ohmyz.sh/)
18+
19+
Run the following command in your termainl.
20+
21+
`sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"`
22+
23+
> **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.
24+
25+
At this point you `must` restart your terminal.
26+
27+
## Bookmark
28+
29+
Bookmark these site to reference later through other classes as needed.
30+
31+
Lots of customization avaliable on their [github repo.](https://github.com/ohmyzsh/ohmyzsh/)
32+
33+
This is a link to a [cheatsheet.](https://github.com/ohmyzsh/ohmyzsh/wiki/Cheatsheet)
34+
35+
---
36+
37+
### [⇐ Previous](./5-tree.md) | [Next ⇒](./7-node.md)

0 commit comments

Comments
 (0)