Skip to content

module specific setup file #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielrazavi merged 3 commits into from
Sep 23, 2025
Merged

module specific setup file #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73d73ba
add setup instructions for module usage
danielrazavi Sep 12, 2025
cfa545a
update README to include SETUP.md and add .venv to .gitignore
danielrazavi Sep 12, 2025
4a8d0c0
update onboarding repo link in README for clarity
danielrazavi Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store
.vscode/
/03_instructional_team/node_modules
.venv
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Participants are encouraged to engage actively during the learning module. They
* Participants are encouraged to ask questions, and collaborate with others to enhance their learning experience.
* Participants must have a computer and an internet connection to participate in online activities.
* Participants must not use generative AI such as ChatGPT to generate code in order to complete assignments. It should be used as a supportive tool to seek out answers to questions you may have.
* We expect learners to have completed the [onboarding repo](https://github.com/UofT-DSI/onboarding/tree/main/onboarding_documents).
* We expect learners to have completed the [onboarding repo](https://github.com/UofT-DSI/onboarding/blob/main/environment_setup/README.md).
* We encourage participants to default to having their camera on at all times, and turning the camera off only as needed. This will greatly enhance the learning experience for all participants and provides real-time feedback for the instructional team.

## Resources
Expand Down Expand Up @@ -131,6 +131,7 @@ Feel free to use the following as resources:
├── 04_this_cohort
├── .gitignore
├── LICENSE
├── SETUP.md
└── README.md
```

Expand All @@ -141,5 +142,6 @@ Feel free to use the following as resources:
* **this_cohort**: Additional materials and resources for this cohort.
* **.gitignore**: Files to exclude from this folder, specified by the Technical Facilitator
* **LICENSE**: The license for this repository.
* **SETUP.md**: Contains the steps required to set up this repo for the module.
* **README**: This file.

11 changes: 11 additions & 0 deletions SETUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Setup

Before using this repo, make sure you’ve completed the [environment setup guide](https://github.com/UofT-DSI/onboarding/blob/main/environment_setup/README.md), which installs the core tools you’ll need for this module, such as:

- Git
- Git Bash (for Windows)
- Visual Studio Code

This module does not require any additional packages.

Once that’s done, simply open your terminal (macOS/Linux) or Git Bash (Windows), and you’re ready to begin this module.