dspace-angular
The next UI for DSpace 7, based on Angular Universal.
This project is currently under active development. For more information on the DSpace 7 release see the DSpace 7.0 Release Status wiki page
You can find additional information on the DSpace 7 Angular UI on the wiki.
Quick start
Ensure you're running Node v8.0.x or v10.0.x, npm >= v5.x and yarn >= v1.x
# clone the repo
git clone https://github.com/DSpace/dspace-angular.git
# change directory to our repo
cd dspace-angular
# install the local dependencies
yarn install
# start the server
yarn start
Then go to http://localhost:3000 in your browser
Not sure where to start? watch the training videos linked in the Introduction to the technology section below.
Table of Contents
- Introduction to the technology
- Requirements
- Installing
- Running the app
- Cleaning
- Testing
- Documentation
- Other commands
- Recommended Editors/IDEs
- Collaborating
- File Structure
- Managing Dependencies (via yarn)
- Frequently asked questions
- License
Introduction to the technology
You can find more information on the technologies used in this project (Angular.io, Typescript, Angular Universal, RxJS, etc) on the LYRASIS wiki
Requirements
If you have nvm or nvm-windows installed, which is highly recommended, you can run nvm install --lts && nvm use to install and start using the latest Node LTS.
Installing
yarn run globalto install the required global dependenciesyarn installto install the local dependencies
Configuring
Default configuration file is located in config/ folder.
To change the default configuration values, create local files that override the parameters you need to change:
- Create a new
environment.dev.jsfile inconfig/fordevelenvironment; - Create a new
environment.prod.jsfile inconfig/forproductionenvironment;
To use the configuration parameters in your component:
import { GLOBAL_CONFIG, GlobalConfig } from '../config';
constructor(@Inject(GLOBAL_CONFIG) public config: GlobalConfig) {}
Running the app
After you have installed all dependencies you can now run the app. Run yarn run watch to start a local server which will watch for changes, rebuild the code, and reload the server for you. You can visit it at http://localhost:3000.
Running in production mode
When building for production we're using Ahead of Time (AoT) compilation. With AoT, the browser downloads a pre-compiled version of the application, so it can render the application immediately, without waiting to compile the app first. The compiler is roughly half the size of Angular itself, so omitting it dramatically reduces the application payload.
To build the app for production and start the server run:
yarn start
If you only want to build for production, without starting, run:
yarn run build:prod
This will build the application and put the result in the dist folder
Deploy
# deploy production in standalone pm2 container
yarn run deploy
# remove production from standalone pm2 container
yarn run undeploy
Running the application with Docker
Cleaning
# clean everything, including node_modules. You'll need to run yarn install again afterwards.
yarn run clean
# clean files generated by the production build (.ngfactory files, css files, etc)
yarn run clean:prod
# cleans the distribution directory
yarn run clean:dist
Testing
Test a Pull Request
If you would like to contribute by testing a Pull Request (PR), here's how to do so. Keep in mind, you do not need to have a DSpace backend / REST API installed locally to test a PR. By default, the dspace-angular project points at our demo REST API
- Pull down the branch that the Pull Request was built from. Easy instructions for doing so can be found on the Pull Request itself.
- Next to the "Merge" button, you'll see a link that says "command line instructions".
- Click it, and follow "Step 1" of those instructions to checkout the pull down the PR branch.
yarn run clean(This resets your local dependencies to ensure you are up-to-date with this PR)yarn install(Updates your local dependencies to those in the PR)yarn start(Rebuilds the project, and deploys to localhost:3000, by default)- At this point, the code from the PR will be deployed to http://localhost:3000. Test it out, and ensure that it does what is described in the PR (or fixes the bug described in the ticket linked to the PR).
Once you have tested the Pull Request, please add a comment and/or approval to the PR to let us know whether you found it to be successful (or not). Thanks!
Unit Tests
Unit tests use Karma. You can find the configuration file at the same level of this README file:./karma.conf.js If you are going to use a remote test enviroment you need to edit the ./karma.conf.js. Follow the instructions you will find inside it. To executing tests whenever any file changes you can modify the 'autoWatch' option to 'true' and 'singleRun' option to 'false'. A coverage report is also available at: http://localhost:9876/ after you run: yarn run coverage.
To correctly run the tests you need to run the build once with: yarn run build.
The default browser is Google Chrome.
Place your tests in the same location of the application source code files that they test.
and run: yarn run test
E2E test
E2E tests use Protractor + Selenium server + browsers. You can find the configuration file at the same level of this README file:./protractor.conf.js Protractor is installed as 'local' as a dev dependency.
If you are going to use a remote test enviroment you need to edit the './protractor.conf.js'. Follow the instructions you will find inside it.
The default browser is Google Chrome.
Protractor needs a functional instance of the DSpace interface to run the E2E tests, so you need to run:yarn run watch
or any command that bring up the DSpace interface.
Place your tests at the following path: ./e2e
and run: yarn run e2e
Continuous Integration (CI) Test
To run all the tests (e.g.: to run tests with Continuous Integration software) you can execute:yarn run ci Keep in mind that this command prerequisites are the sum of unit test and E2E tests.
Documentation
See ./docs for further documentation.
Building code documentation
To build the code documentation we use TYPEDOC. TYPEDOC is a documentation generator for TypeScript projects. It extracts informations from properly formatted comments that can be written within the code files. Follow the instructions here to know how to make those comments.
Run:yarn run docs to produce the documentation that will be available in the 'doc' folder.
Other commands
There are many more commands in the scripts section of package.json. Most of these are executed by one of the commands mentioned above.
A command with a name that starts with pre or post will be executed automatically before or after the script with the matching name. e.g. if you type yarn run start the prestart script will run first, then the start script will trigger.
Recommended Editors/IDEs
To get the most out of TypeScript, you'll need a TypeScript-aware editor. We've had good experiences using these editors:
- Free
- Paid
Collaborating
File Structure
dspace-angular
├── README.md * This document
├── app.yaml * Application manifest file
├── config * Folder for configuration files
│ ├── environment.default.js * Default configuration files
│ └── environment.test.js * Test configuration files
├── docs * Folder for documentation
├── e2e * Folder for e2e test files
│ ├── app.e2e-spec.ts *
│ ├── app.po.ts *
│ ├── pagenotfound *
│ │ ├── pagenotfound.e2e-spec.ts *
│ │ └── pagenotfound.po.ts *
│ └── tsconfig.json * TypeScript configuration file for e2e tests
├── karma.conf.js * Karma configuration file for Unit Test
├── nodemon.json * Nodemon (https://nodemon.io/) configuration
├── package.json * This file describes the npm package for this project, its dependencies, scripts, etc.
├── postcss.config.js * PostCSS (http://postcss.org/) configuration file
├── protractor.conf.js *
├── resources * Folder for static resources
│ ├── data * Folder for static data
│ │ └── en * Folder for i18n English data
│ ├── i18n * Folder for i18n translations
│ │ └── en.json * i18n translations for English
│ └── images * Folder for images
│ ├── dspace-logo-old.png *
│ ├── dspace-logo.png *
│ └── favicon.ico *
├── rollup.config.js * Rollup (http://rollupjs.org/) configuration
├── spec-bundle.js *
├── src * The source of the application
│ ├── app *
│ │ ├── app-routing.module.ts *
│ │ ├── app.component.html *
│ │ ├── app.component.scss *
│ │ ├── app.component.spec.ts *
│ │ ├── app.component.ts *
│ │ ├── app.effects.ts *
│ │ ├── app.module.ts *
│ │ ├── app.reducer.ts *
│ │ ├── browser-app.module.ts * The root module for the client
│ │ ├── +collection-page * Lazily loaded route for collection module
│ │ ├── +community-page * Lazily loaded route for community module
│ │ ├── core *
│ │ ├── header *
│ │ ├── +home * Lazily loaded route for home module
│ │ ├── +item-page * Lazily loaded route for item module
│ │ ├── object-list *
│ │ ├── pagenotfound *
│ │ ├── server-app.module.ts * The root module for the server
│ │ ├── shared *
│ │ ├── store.actions.ts *
│ │ ├── store.effects.ts *
│ │ ├── thumbnail *
│ │ └── typings.d.ts * File that allows you to add custom typings for libraries without TypeScript support
│ ├── backend * Folder containing a mock of the REST API, hosted by the express server
│ │ ├── api.ts *
│ │ ├── cache.ts *
│ │ ├── data *
│ │ └── db.ts *
│ ├── config *
│ │ ├── cache-config.interface.ts *
│ │ ├── config.interface.ts *
│ │ ├── global-config.interface.ts *
│ │ ├── server-config.interface.ts *
│ │ └── universal-config.interface.ts *
│ ├── config.ts * File that loads environmental and shareable settings and makes them available to app components
│ ├── index.csr.html * The index file for client side rendering fallback
│ ├── index.html * The index file
│ ├── main.browser.ts * The bootstrap file for the client
│ ├── main.server.ts * The express (http://expressjs.com/) config and bootstrap file for the server
│ ├── modules *
│ │ ├── cookies *
│ │ ├── data-loader *
│ │ ├── transfer-http *
│ │ ├── transfer-state *
│ │ ├── transfer-store *
│ │ └── translate-universal-loader.ts *
│ ├── routes.ts * The routes file for the server
│ ├── styles * Folder containing global styles
│ │ ├── _mixins.scss *
│ │ └── variables.scss * Global sass variables file
│ ├── tsconfig.browser.json * TypeScript config for the client build
│ ├── tsconfig.server.json * TypeScript config for the server build
│ └── tsconfig.test.json * TypeScript config for the test build
├── tsconfig.json * TypeScript config
├── tslint.json * TSLint (https://palantir.github.io/tslint/) configuration
├── typedoc.json * TYPEDOC configuration
├── webpack * Webpack (https://webpack.github.io/) config directory
│ ├── helpers.js *
│ ├── webpack.aot.js * Webpack (https://webpack.github.io/) config for AoT build
│ ├── webpack.client.js * Webpack (https://webpack.github.io/) config for client build
│ ├── webpack.common.js *
│ ├── webpack.prod.js * Webpack (https://webpack.github.io/) config for production build
│ ├── webpack.server.js * Webpack (https://webpack.github.io/) config for server build
│ └── webpack.test.js * Webpack (https://webpack.github.io/) config for test build
├── webpack.config.ts *
└── yarn.lock * Yarn lockfile (https://yarnpkg.com/en/docs/yarn-lock)
Managing Dependencies (via yarn)
This project makes use of yarn to ensure that the exact same dependency versions are used every time you install it.
yarncreates ayarn.lockto track those versions. That file is updated automatically by whenever dependencies are added/updated/removed via yarn.- Adding new dependencies: To install/add a new dependency (third party library), use
yarn add. For example:yarn add some-lib.- If you are adding a new build tool dependency (to
devDependencies), useyarn add some-lib --dev
- If you are adding a new build tool dependency (to
- Upgrading existing dependencies: To upgrade existing dependencies, you can use
yarn upgrade. For example:yarn upgrade some-liboryarn upgrade some-lib@version - Removing dependencies: If a dependency is no longer needed, or replaced, use
yarn removeto remove it.
As you can see above, using yarn commandline tools means that you should never need to modify the package.json manually. We recommend always using yarn to keep dependencies updated / in sync.
Adding Typings for libraries
If the library does not include typings, you can install them using yarn:
yarn add d3
yarn add @types/d3 --dev
If the library doesn't have typings available at @types/, you can still use it by manually adding typings for it:
-
In
src/typings.d.ts, add the following code:declare module 'typeless-package'; -
Then, in the component or file that uses the library, add the following code:
import * as typelessPackage from 'typeless-package'; typelessPackage.method();
Done. Note: you might need or find useful to define more typings for the library that you're trying to use.
If you're importing a module that uses CommonJS you need to import as
import * as _ from 'lodash';
Frequently asked questions
- Why is my service, aka provider, is not injecting a parameter correctly?
- Please use
@Injectable()for your service for typescript to correctly attach the metadata
- Please use
- Where do I write my tests?
- You can write your tests next to your component files. e.g. for
src/app/home/home.component.tscall itsrc/app/home/home.component.spec.ts
- You can write your tests next to your component files. e.g. for
- How do I start the app when I get
EACCESandEADDRINUSEerrors?- The
EADDRINUSEerror means the port3000is currently being used andEACCESis lack of permission to build files to./dist/
- The
- What are the naming conventions for Angular 2?
- Why is the size of my app larger in development?
- The production build uses a whole host of techniques (ahead-of-time compilation, rollup to remove unreachable code, minification, etc.) to reduce the size, that aren't used during development in the intrest of build speed.
- node-pre-gyp ERR in yarn install (Windows)
- install Python x86 version between 2.5 and 3.0 on windows. See this issue
- How do I handle merge conflicts in yarn.lock?
- first check out the yarn.lock file from the branch you're merging in to yours: e.g.
git checkout --theirs yarn.lock - now run
yarn installagain. Yarn will create a new lockfile that contains both sets of changes. - then run
git add yarn.lockto stage the lockfile for commit - and
git committo conclude the merge
- first check out the yarn.lock file from the branch you're merging in to yours: e.g.
License
This project's source code is made available under the DSpace BSD License: http://www.dspace.org/license
