Home / Guides / Project Setup

Project Setup

Follow these steps every time you start a new mini project or the final project. What goes inside the repository, from PROPOSAL.md to the README, is set by that project's spec on Canvas.

1. Create the Repo on GitHub

  1. Go to github.com and click New Repository (the green button or the + in the top right)
  2. Name it something descriptive (e.g., recipe-site, budget-tracker)
  3. Set it to Public
  4. Check Add a README file
  5. Click Create repository

2. Clone to Your Computer

In VS Code: Ctrl+Shift+P (Windows) or Cmd+Shift+P (macOS) > type "Git: Clone" > paste your repo URL > choose a folder.

Or in GitHub Desktop: File > Clone Repository > select the repo you just created.

3. Add What the Project Spec Asks For

Open the project's spec on Canvas and create the files it lists, with the names it gives. Commit and push as you add them.

4. Activate GitHub Pages

Follow step 1 of the GitHub Pages guide to turn on Pages for this repo. This is the same process you used for your personal site.

Open the README.md in your main oim3690 repo and update the Projects table with your new repo and live URL. If you have not set up the table yet, download the README template from the course website.

Last updated: Monday, 9/14/2026