Versions Compared

Key

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

...

  1. First, install all the Frontend Requirements listed above & verify the backend/REST API is publicly accessible.
  2. Download the latest dspace-angular release from the DSpace GitHub repository. You can choose to either download the zip or tar.gz file provided by GitHub, or you can use "git" to checkout the appropriate tag (e.g. dspace-7.0-beta5) or branch.
  3. Install all necessary local dependencies by running the following from within the unzipped "dspace-angular" directory

    Code Block
    # change directory to our repo
    cd dspace-angular
    
    # install the local dependencies
    yarn install


  4. Create a Production Configuration file at [dspace-angular]/src/environment/environment.prod.ts. You may wish to use the environment.template.ts as a starting point. This environment.prod.ts file can be used to override any of the default configurations specified in the environment.common.ts (in that same directory).  At a minimum this file MUST include the "ui" and "rest" sections similar to the following (keep in mind, you only need to include settings that you need to modify): 

    Code Block
    export const environment = {   
       // This example is valid if your BackendUI iswill publiclybe availablerunning at https://api.mydspace.edu/server/ 
      // It should be kept in sync with the value of "dspace.serverui.url" in the backend's local.cfg
      rest ui: { 
          ssl: true, 
          host: 'api.mydspace.edu',
          port: 80443, 
          // NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
          nameSpace: '/server' 
      }
       // This example is valid if your UIBackend willis bepublicly runningavailable at https://api.mydspace.edu/server/ 
      // It should be kept in sync with the value of "dspace.uiserver.url" in the backend's local.cfg 
      ui rest: { 
          ssl: true, 
          host: 'api.mydspace.edu', 
          port: 4000443, 
          // NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
          nameSpace: '/server' 
      }
    };


    1. NOTE: If this is the first time you are running the UI, in the "ui" section above, you may want to start with "ssl: false" and "port: 4000" just to be certain that everything else is working properly.  With those settings in place, you can quickly test your UI by running "yarn start" and accessing it via http://[mydspace.edu]:4000/
    2. If there are other settings you know you need to modify in the default environment.common.ts configuration file you can also copy them into this same file.
  5. Start the application

    Code Block
    # build and start the application
    yarn start


    1. To stop the application at any time, use Ctrl + C
  6. After a few minutes, the user interface will be running on your local machine. 
    1. Visit http://localhost:4000/
    2. For an example of what the default frontend looks like, visit the Demo Frontend: https://demo7.dspace.org/ 

...