Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. These test instructions assume you are already running both the Frontend & Backend. If not, follow the instructions above, and then start them both:

    Code Block
    # Start backend
    cd DSpace
    docker-compose -p d7 up -d
    
    # Start frontend
    cd ../dspace-angular
    docker-compose -p d7 -f docker/docker-compose.yml up -d


  2. First, move into the directory where your Backend code is

    Code Block
    cd DSpace


  3. Find the number of the Pull Request you want to test (it'll be the "#[number]" displayed after the PR name, or the end of the PR's URL).  Checkout the code from that PR using it's number: 

    Code Block
    # This would checkout https://github.com/DSpace/DSpace/pull/8007 for testing
    gh pr checkout 8007


  4. Now, rebuild & restart your backend based on that PR's code:

    Code Block
    docker-compose -p d7 up -d --build
    # Even after the build completes, it makemay take a few minutes for the backend to restart
    
    # You can check the status using "logs -f"
    docker-compose -p d7 logs -f
    # (Click Ctrl+C to exit logs view)


  5. Now test the User Interface to see if the changes made in that PR look to work properly.  If there was a corresponding UI PR, make sure you also follow the instructions in "Testing a Frontend PR" to install that PR as well.
    1. If you notice any odd behavior, check for errors in the UI using your browser's DevTools. See Troubleshoot an error#FindingtheErrorMessageintheUserInterface
    2. Based on what you find, add a comment to the PR. If it works, congratulate the developer. If it doesn't, let them know the error you saw (and what you clicked on when that error occurred).


Other Tips

Need to

...

startup the frontend & backend?

After restarting your computer, the frontend & backend will be stopped. If you previously installed both & simply need to start them up again, run the following:

Code Block
# Start backend
cd DSpace
docker-compose -p d7 up -d

# Start frontend
cd ../dspace-angular
docker-compose -p d7 -f docker/docker-compose.yml up -d


Need to shutdown everything?

NOTE: While this shuts down the Docker containers, all the data/files/user accounts you created will be retained (and will appear the next time to start the containers)

Code Block
# From your local "DSpace" folder run. This stops BOTH the frontend and the backend
docker-compose -p d7 down

# NOTE: You also can stop both from your

NOTE: While this shuts down the Docker containers, all the data/files/user accounts you created will be retained (and will appear the next time to start the containers)

Code Block
# From either the "DSpace" or "dspace-angular" folder, but the command is slightly longer:
# docker-compose -p d7 -f docker/docker-compose.yml down

Need to revert back to the "main" codebase (i.e. uninstall the PR code)?

...