EX04 - Implementing Todo APIs


Initialize The Starter Repository

On your HOST machine, both members of the team should follow these instructions together:

  1. From VSCode, open a new, blank VSCode Window on your HOST machine
  2. Command Palette > Git Clone: https://github.com/comp423-24f/ex04-starter.git
  3. After cloning DO NOT follow pop-up suggestions! FIRST:
    1. Open and read/follow steps in the docs directory’s get_started.md file.
    2. Before Starting the DevContainer: Establish a .env File in backend/
    3. Once the DevContainer is installed: Run pushd frontend; npm i; popd frontend
  4. After starting the container, complete the getting started steps in section “Start the DevContainer” all the way up to “Development Data”

Team Member 0. Setup Team on GitHub Classroom and Configure Remotes/Branches

ONLY ONE MEMBER OF YOUR PAIRING NEEDS TO FOLLOW THESE STEPS

  1. One member of the team should carefully create the team. Create a team named “EX04 NN” where the NN is the TEAM NUMBER of your group on the pairings page linked to here. Check it closely! Accept the assignment on behalf of your team and, after refreshing, it will create a repository at a location like github.com/comp423-24f/ex04-todo-api-team<your team>. Assignment acceptance link: https://classroom.github.com/a/cBgjYUwK
  2. “Rename” the origin remote repository to upstream:
    • git remote rm origin
    • git remote add upstream https://github.com/comp423-24f/ex04-starter.git
  3. Fetch upstream branches:
    • git fetch upstream
  4. Switch to the ex04-starter starter branch, then create a branch named ex04 at this point where you will do your work:
    • git switch ex04-starter (This should not error out! If it does, check prior steps. You should not manually create this branch.)
    • git switch --create ex04
  5. Add origin remote to refer to your team project:
    • git remote add origin [INSERT YOUR TEAM'S REPOSITORY URL FROM GITHUB HERE]
  6. Push your ex04 branch to your GitHub repository (now the remote named origin):
    • git push origin ex04
  7. Open GitHub to your team’s repository and confirm that a branch named ex04 was pushed! You should see the last commit made by krisjordan with a commit message of “Updating docker-compose.yml”.
  8. You can also view this commit locally: git log -1

Team Member 1. Configure Remotes/Branches

Only the member of the team who did not complete the steps above, should complete these steps.

After YOUR TEAMMATE has completed their steps above, you should join the correct team and accept the assignment. This will add you to your team’s repository on GitHub. Assignment acceptance link: <> Then continue with your local repository setup:

  1. “Rename” the origin remote repository to upstream:
    • git remote rm origin
    • git remote add upstream https://github.com/comp423-24f/ex04-starter.git
  2. Add origin remote to refer to your team project:
    • git remote add origin [INSERT YOUR TEAM'S REPOSITORY URL FROM GITHUB HERE]
  3. Fetch your team’s branches:
    • git fetch origin
  4. Switch to your team’s ex04 branch:
    • git switch ex04

Completing the Assignment

Once your repository has been set up, access the /docs/exercises/ex04.md file. This file includes instructions on how to proceed with the assignment.

Contributor(s): Ajay Gandecha