You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/lab_0/index.md
+39-31Lines changed: 39 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,10 +10,7 @@ The goals for this tutorial are:
10
10
The assignment requirements are as follows:
11
11
1. Replicate the local environment created in class on your own computer ([Installations](#installations))
12
12
2. Fork this repository, set up github pages, and initialize your upstream repository ([Github Setup](#github-setup))
13
-
14
-
To submit your assignment, TODO
15
-
16
-
13
+
3. Submit your [deployed link](#4-set-up-your-github-pages-for-your-deployment) as a comment on the lab 0 commons post.
17
14
18
15
# Installations
19
16
@@ -34,7 +31,7 @@ The first step is to install all the appropriate software to get our environment
34
31
35
32
You can read more about `forking`, `syncing`, and the overall github flow [here](https://help.github.com/en/github/getting-started-with-github/fork-a-repo).
36
33
37
-
###1. On Gitub, within to our [main repository](https://github.com/InteractiveDataVis/Interactive-Data-Vis-Fall2025.git) and [`fork`](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) this repository into your own account.
34
+
## 1. On Gitub, within to our [main repository](https://github.com/InteractiveDataVis/Interactive-Data-Vis-Fall2025.git) and [`fork`](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) this repository into your own account.
38
35
39
36
To do this, click on the "fork" button on the top right of this github account.
40
37
@@ -46,15 +43,7 @@ This creates a clone of our class repository in your own github account. After t
46
43
47
44
This repository is _your_ personal copy of the existing repository. This will be where you do all your lab work, and will include the deployed links that you will submit when turning in your assignments.
48
45
49
-
### 2. Set up your Github Pages for your deployment
50
-
51
-
We use [Github Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/what-is-github-pages) to serve our websites publicly. Github Pages is static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website.
52
-
53
-
<!-- To [set up your github pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site), you can go to your repository's `Settings` tab and then scroll down to `Pages` section. Select `Github Actions` as source ("Deploy from a branch") and then your site will be avallable at `https://[YOUR_USERNAME].github.io/[YOUR_REPOSITORY_NAME]/`. *NOTE*: You must navidate in the URL to a folder with an index.html, or else you will get a 404. This will take a few minutes to update with any pushed changes. -->
### 3. On GitHub, navigate to **your fork** of the repository and clone it to your local computer.
46
+
## 2. On GitHub, navigate to **your fork** of the repository and clone it to your local computer.
58
47
59
48
To do this, navigate to the folder where you want to save your files (I like to save mine in `Documents/Repositories`). (Hint: `cd` or 'change directory' will help you get there through terminal).
### 4. Set up your local repository so that it links back to the course repository.
63
+
##3. Set up your local repository so that it links back to the course repository.
75
64
76
65
We do this so that you can keep your local branch synced up with the main course repository when we update the material. With this set up, you can simply `pull` in the new changes from our original class repository.
77
66
@@ -103,23 +92,24 @@ $ git remote -v
103
92
# now notice see that we are tracking both the original and your version of the repository
104
93
```
105
94
106
-
### 6. Keep your repository [synced](https://help.github.com/en/github/getting-started-with-github/fork-a-repo#keep-your-fork-synced).
107
95
108
-
Make sure to do this before working on new code (before each tutorial) to ensure that you are working off of the latest updates. We may update the course repository at some point in the semester, and this command will update your fork to include the changes we made, including that week's class example or other materials we have added.
96
+
## 4. Set up your Github Pages for your deployment
109
97
110
-
```sh
111
-
# pulls the upstream changes and stores them in `upstream/main`
112
-
$ git fetch upstream
113
-
```
98
+
We use [Github Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/what-is-github-pages) to serve our websites publicly. Github Pages is static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website.
114
99
115
-
```sh
116
-
# merges the changes from upstream into your current branch
117
-
$ git merge upstream/main
118
-
```
100
+
To [set up your github pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site), you can go to your repository's `Settings` tab and then scroll down to `Pages` section. Select `Github Actions` as source ("Deploy from a branch").
101
+
102
+
<imgsrc='assets/pages.png'width='700px'>
119
103
120
-
(You can read more information about this [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork))
104
+
The workflow code is already included in the main class repository. When you push your changes up to github, then your site will automatically be redeployed and be avallable at `https://[YOUR_USERNAME].github.io/[YOUR_REPOSITORY_NAME]/`.
121
105
122
-
### 7. Push up and deploy your changes
106
+
You can see all the deployments triggered from pushed in the deployments section of your repository page.
107
+
108
+
<imgsrc='assets/deployments.png'width='700px'>
109
+
110
+
*NOTE*: You must navidate in the URL to a folder with an index.html, or else you will get a 404. This will take a few minutes to update with any pushed changes.
111
+
112
+
### 5. Push up and deploy your changes
123
113
124
114
[Note: VS Code has some great [tools](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support) built in to help with this process.]
125
115
@@ -161,9 +151,26 @@ More resources to understand these interfaces:
*[Complete List: Command Line Prompt (CMD)](https://www.codecademy.com/article/command-line-commands)
163
153
164
-
## Helpful terminal commands for navigation
165
154
166
-
### Windows Command Prompt (CMD)
155
+
### Keeping your repository synced
156
+
157
+
As the semester progresses, updates may be pushed to the class repository. The following terminal commands can keep your repo [synced](https://help.github.com/en/github/getting-started-with-github/fork-a-repo#keep-your-fork-synced). Make sure to do this before working on new code to ensure that you are working off of the latest updates.
158
+
159
+
```sh
160
+
# pulls the upstream changes and stores them in `upstream/main`
161
+
$ git fetch upstream
162
+
```
163
+
164
+
```sh
165
+
# merges the changes from upstream into your current branch
166
+
$ git merge upstream/main
167
+
```
168
+
169
+
(You can read more information about this process [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork))
170
+
171
+
### Helpful terminal commands for navigation
172
+
173
+
**Windows Command Prompt (CMD)**
167
174
168
175
-`dir`: List files and folders in current directory
169
176
-`cd [folder]`: Change directory (e.g., cd Documents)
@@ -175,7 +182,7 @@ More resources to understand these interfaces:
175
182
-`copy [source] [destination]`: Copy files
176
183
-`move [source] [destination]`: Move/rename files
177
184
178
-
### macOS/Linux Terminal
185
+
**macOS/Linux Terminal**
179
186
180
187
-`ls`: List files and folders (ls -la for detailed view)
181
188
-`cd [folder]`: Change directory
@@ -186,4 +193,5 @@ More resources to understand these interfaces:
186
193
-`rmdir [name]`: Remove empty folder
187
194
-`rm [filename]`: Delete file (rm -r [folder] for folders)
0 commit comments