Versions Compared

Key

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

...

  1. First, install the necessary prerequisites. You will just need to install three things: Docker Desktop (to run Docker), Git Bash (to access our shared Docker compose files) and finally download those shared Docker compose files.
    1. Instructions for Windows 10
    2. Instructions for Mac OS
    3. Instructions for Linux 
  2. Next, run the "DSpace 7 With Entities" Docker compose commands detailed at: https://github.com/DSpace-Labs/DSpace-Docker-Images/blob/master/documentation/run.DSpace7Entities.md
    1. We recommend using the "DSpace 7 Preview Release" commands detailed on that page, as those will ensure you also see the new sample DSpace 7 Theme (tentatively titled "Mantis")
    2. If you'd rather see the default Bootstrap look and feel (unthemed DSpace 7), use the "latest DSpace 7" instructions listed on that page.
  3. After a few minutes, you should have a full local installation of DSpace 7 Preview (with test data).
    1. User Interface: http://localhost:3000/
    2. REST API: http://localhost:8080/spring-rest
    3. Admin Login: dspacedemo+admin@gmail.com, Password: dspace
    4. Submitter Login: dspacedemo+submit@gmail.com, Password: dspace
  4. Objects of interest (within the test data):
    1. Journal Example represents a journal with journal volumes, issues and articles, as detailed in the Configurable Entities Design.
    2. Publications Example contains publications which contain a combination of plain-text authors and related author entities. It also contains relations to Research Projects and Organizational Units, as detailed in the Configurable Entities design. Navigating to e.g. a Person will reveal their relations to Publications, Research Projects and Organizational Units.
    3. Submission/Workflow functionality can be tested using one of the collections in this community where the workflow is enabled. You can use the accounts mentioned above to perform the submission and workflow steps. The admin account can perform the submission and all workflow steps as well.
  5. Once you are done testing, you can stop Docker and clean up the data (deleting the volumes).  More information can be found in the instructions at https://github.com/DSpace-Labs/DSpace-Docker-Images/blob/master/documentation/run.DSpace7Entities.md

Install the User Interface only

Running only the DSpace 7 user interface can be done quickly & easily on any operating system (Windows, Mac OS, or Linux).  By default, the installed user interface will use the DSpace 7 REST API Demo (https://dspace7.4science.cloud/dspace-spring-rest/as its backend.  This means that you will immediately see test data (from that demo site) and be able to interact with it.  However, you will need to authenticate using the REST API Demo account. Any changes you make will also obviously appear on that shared REST API Demo site.

  1. First, you will need to install the necessary prerequisites.
    1. Git is required.  If you do not already have it installed (try running git version at your command line), you can install it via https://git-scm.com/downloads (or via your local package manager tools for Linux or Mac OS)
    2. Node.js (v8.x or above) is required. Installing the latest LTS (Long Term Support) version, currently 10.x, is perfectly fine.
      1. NPM (v5.x or above) is required.  Don't worry, this gets installed with Node.js though, so you don't need to do anything extra here.
    3. Yarn (v1.x or above) package manage.  Just install the latest stable version (currently 1.16.x).
  2. Then, download our "dspace-angular" application (which is the DSpace 7 user interface) and run it.  All you should need to do is the steps in the "Quick Start" at: https://github.com/DSpace/dspace-angular/#quick-start
  3. After a few minutes, the user interface will be running on your local machine.  Again, it will be accessing the REST API Demo site, so a stable internet connection is required.
    1. User Interface: http://localhost:3000/
    2. REST API (remote demo site): https://dspace7.4science.cloud/dspace-spring-rest/
    3. Admin Login: dspacedemo+admin@gmail.com, Password: dspace
    4. Submitter Login: dspacedemo+submit@gmail.com, Password: dspace
  4. Objects of interest (within the test data):
    1. Journal Example represents a journal with journal volumes, issues and articles, as detailed in the Configurable Entities Design.
    2. Publications Example contains publications which contain a combination of plain-text authors and related author entities. It also contains relations to Research Projects and Organizational Units, as detailed in the Configurable Entities design. Navigating to e.g. a Person will reveal their relations to Publications, Research Projects and Organizational Units.
    3. Submission/Workflow functionality can be tested using one of the collections in this community where the workflow is enabled. You can use the accounts mentioned above to perform the submission and workflow steps. The admin account can perform the submission and all workflow steps as well.
  5. One you are done testing, you can stop the locally running DSpace 7 user interface via Ctrl+C