Skip to content

rero/rero-ils-ui

Repository files navigation

Github actions status image Release Number License Gitter room

Public search:
Translation status

Professional interface (admin):
Translation status

Shared:
Translation status

Copyright (C) 2020 RERO Copyright (C) 2020 UCLouvain

Introduction

Rero-ils-ui is a part of RERO21 project.

It's a Web UI (User Interface) of rero-ils for libraries management.

This interface aims to be simple and clear. It's made with Angular CLI.

Requirements

We strongly recommend the use of nvm.

And then:

Optionnaly, for development purposes, you can install an IDE such as Visual Studio Code, Atom, WebStorm, etc.

Quick start

After having launched RERO-ILS server:

# Install nvm
$ wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.1/install.sh | bash
# reload shell environment to activate nvm
$ source ~/.bashrc
# Install npm
$ nvm install lts/erbium

# Get RERO-ILS-UI and use specific npm
$ git clone https://github.com/rero/rero-ils-ui.git/
$ cd rero-ils-ui
$ nvm use lts/erbium
# Install angular-cli
$ npm i -g @angular/cli@8.3.28
# Project npm dependencies
$ npm i
# Build shared library
$ ng build shared --watch
# Launch a local server using a proxy for https://localhost:5000 (rero-ils server)
$ npm run start-admin-proxy

How to update Node version with nvm

In case you're updating Node version with nvm:

# First check you node version
node --version # here, 10.16.3
nvm install lts/erbium --reinstall-packages-from=10.16.3
nvm uninstall 10.16.3

Development server

Run the rero-ils dev server on https://localhost:5000 and run npm run start-admin-proxy or npm run start-public-search-proxy for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Production mode

To run all applications in production, just do:

npm run build

It generates all needed files in dist directory.

Running unit tests

Run ./run-tests.sh to execute linting and the unit tests via Karma.

This will do headless browser tests (no Graphical User Interface).

To check test in live, do: ng test [project_name]

where project_name is one of:

  • admin
  • public-search
  • search-bar

Run only one test

For example with projects/admin/src/app/menu/menu.component.spec.ts file:

ng test --main projects/admin/src/app/menu/menu.component.spec.ts

Tip: Chromium users

For Chromium users, it would be necessary to set CHROME_BIN variable:

CHROME_BIN=`which chromium` ./run-tests.sh

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Translations

Commands:

  • npm run admin_extract_messages: will extract all strings in admin project and put them in en_US.json file (source file)
  • npm run admin_update_catalog: will extract all string in source file and put them into de/en/fr/it json files for translation
  • npm run public-search_extract_messages: same as admin, but for public-search project
  • npm run public-search_update_catalog: same as admin, but for public-search project
  • npm run extract_messages: launches admin_extract_messages and public-search_extract_messages commands
  • npm run update_catalog: launches public-search_update_catalog and admin_update_catalog commands

About

User interface for RERO integrated library system (RERO ILS).

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages