Work on a Project Locally

Complete the local setup for your operating system before following this page.

Choose a project location

Make a folder for your CS projects. Avoid spaces in folder names and avoid OneDrive, iCloud, Dropbox, or other synchronized folders. Synchronization programs can interfere with Git and build tools.

Set up the Code

Use one of these methods to get the project code on your computer.

A. Clone code from GitHub

For projects that began in Codespaces. Or if you want to be able to synchronize with a GitHub repository.

  1. Make a Github repository from the Chemeketa project template required by your assignment. (Or find your existing repository on GitHub.)
  2. In VSCode, open the Command Palette with Ctrl+Shift+P or Cmd+Shift+P.
  3. Run Git: Clone.
  4. Select Clone from GitHub and authorize VS Code if prompted.
  5. Select the project repository.
  6. Choose your CS projects folder on your computer as the destination.
  7. Open the cloned project when VS Code prompts you.

B. Start a completely local project

If you just want to work on a project locally without using GitHub, download the prepared release described under Create a project without GitHub.

Open the whole project folder in VS Code (File > Open Folder).

Do not open single files in VS Code. Opening a folder is required for the build and debugger to work correctly (they need the Makefile and .vscode folder).

Build and run

Open Run and Debug, select the configuration for your platform and target, and start the program. See Compile and Run to build from the terminal.

Switch between development environments

A GitHub repository lets you work on the same project in Codespaces, directly on your computer, or in WSL. GitHub is the handoff point between those working copies.

Before leaving the current environment

  1. Save every file.
  2. Confirm that Worklog committed the latest changes.
  3. Open Source Control and select Sync Changes or Push.
  4. Open the repository on GitHub and confirm the latest commit appears.
  5. Close the project or stop the Codespace.

When entering the other environment

  • If this is the first time using the project there, clone the repository.
  • If it has already been cloned, pull or sync before editing anything.
  • Resolve any reported conflict before continuing to work.
Do not edit the same project in two environments at the same time. Worklog can create commits in both copies, making conflicts more likely.

Downloading a ZIP is appropriate for submitting an assignment or making a snapshot. It is not the normal way to move an active project between development environments because the ZIP is disconnected from its GitHub repository.