...

Getting ready

Step 1:

...

Install required software

To start working on PR review and testing, the following application applications are needed:

• GitHub login. This lets you add a comment to any PR you test, letting developers know if you found problems or if all your tests were successful.
• GIT https://git-scm.com/downloads
• Install GitHub CLI.  This makes it easier to "checkout" (i.e. download) the PR code so you can test it.
• Install Docker Desktop. This is the easiest way to get a DSpace backend installed locally for testing new (frontend or backend) PRs.
  • Windows 11: ensure Hyper-V are turned on in the Windows Features (TO ADD). May require administrator rights on the computer.
  • Once installed, you will require be required to restart your computer. When first launchlaunched, may have an error mentionning may appear mentioning that WSL for Windows is needed. Is If so,   install WSL. When Installing WSL you will be asked for a Linux Distro.
  • NOTE: Docker recently changed their service agreement, but Docker remains free for personal use or non-commercial open source projects like DSpace.

  • NOTE for Windows 10: Docker Desktop can sometimes become a bit "memory-hungry" when it is running.  It's best to either disable the "Start Docker Desktop when you log in" setting (so that you it only run it runs when needed).  OrAlternatively, if you are using the default WSL2 backend, you can create a ".wslconfig" file in your user directory and limit the amount of memory you let Docker use (at least 4-8GB is recommended if you can spare it):

    Code Block
    title .wslconfig
    [wsl2] memory=8GB

    
    

...