Skip to content

Setup Guide

Gunes315 edited this page Jun 2, 2024 · 1 revision

Download

  1. Download and extract the newest squeak image
  2. On Windows, run the squeak.bat file in the extracted image directory
  3. You may have to allow squeak to run as it could be blocked by default

Setup

  1. Complete the setup-wizard by clicking Configure in the welcome overlay

Git

  1. Run the Git Browser (either the 'for experts' or the normal version from the App menu image

  2. The browser might prompt you to create a local project. Select No (n) image

  3. Right-Click the Projects-Section and select Clone Project image

  4. Enter the https url for the PixelEditor repository https://github.com/hpi-swa-teaching/PixelEditor.git click Accept image

  5. Select a directory for the git project. This is not the same as your squeak image. You can choose to add it into the image directory but it is adviced to create a extra folder for it

  6. Enter your first and last name. This will be used for future commit messages image

  7. Enter a email address. This too will be added to your commit messages and will be public! image

  8. Enter a name for the project. It is adviced to use the same name as the repository. In this cas PixelEditor image

  9. The project is loaded (main branch) image

Optional: Push Commits

  1. You can already view and edit local commits but pushing is not possible. Set it up by clicking Push in the Git browser UI

  2. Enter your github username. Double check that you have all required permissions for the repository including write permissions. Do not put in your password in the next dialoug box! image

  3. Head over to Github and click on your profile picture in the top right. Click on Settings image

  4. Scroll down and select Developer settings in the sidebar image

  5. Select Token (classic) from the Personal access tokens entry. image

  6. Select Token (Classic) from the Generate new token button in the top right image

  7. Enter a token note and a expiration date. Allow at minimum the write:packages and read:packages permissions image

  8. Click Generate and note your acess token from the next screen.

  9. Return to Squeak and enter the token into the password input. After submitting Squeak will try to push your commits.

Maybe Squeak will run into an error. In that case switch the app from Git Browser to Git for experts or try the command line version when prompted.