Skip to content

About

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

Resources

Stars

10 stars

Watchers

8 watching

Forks

Latest commit

 

History

1,228 Commits

Folders and files

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-2026 RERO Copyright (C) 2020-2024 UCLouvain

Introduction

Rero-ils-ui is a part of RERO ILS.

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 22.

Requirements

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

Quick start

After having launched RERO-ILS server:

# Install Node.js 24 (nvm is recommended: https://github.com/nvm-sh/nvm)
$ nvm install 24

# Enable Corepack (ships with Node.js, manages the pnpm version pinned in package.json)
$ corepack enable

# Get RERO-ILS-UI
$ git clone https://github.com/rero/rero-ils-ui.git
$ cd rero-ils-ui

# Project dependencies (also cleans an existing node_modules)
$ pnpm ci

# Build the shared library in watch mode (required, other projects depend on it)
# Keep this running in a separate terminal so changes rebuild automatically
$ pnpm exec ng build shared --watch

# Launch a local server using a proxy for https://localhost:5000 (rero-ils server)
$ pnpm run start-admin-proxy

Development server

Run the rero-ils dev server on https://localhost:5000 and run one of the pnpm run start-*-proxy scripts for a dev server: admin on https://localhost:4200/, the other apps on the ports 4201 to 4204 (see .ai/dev-commands.md). The app will automatically reload if you change any of the source files.

Production mode

To build all applications in production, just do:

pnpm run build

It generates all needed files in the dist directory.

To install the build in a local rero-ils, pack it, then pass the tarball to the bootstrap script of rero-ils:

pnpm run pack   # creates rero-rero-ils-ui-X.X.X.tgz
cd ../rero-ils && ./scripts/bootstrap -t ../rero-ils-ui/rero-rero-ils-ui-X.X.X.tgz

Using an unpublished ng-core

To build against a local ng-core, pack it (pnpm run pack in ../ng-core) and add an override to pnpm-workspace.yaml, then run pnpm install:

overrides:
  '@rero/ng-core': 'file:../ng-core/rero-ng-core-X.X.X.tgz'

Do not commit this override. The CI builds ng-core from the reference written in .ng-core-ref (published, a branch of rero/ng-core, or owner/ng-core@branch).

Running unit tests

All projects use Vitest (@angular/build:unit-test).

Run all tests:

pnpm test

Run tests for a specific project:

pnpm exec ng test [project_name]

where project_name is one of:

  • admin
  • public-search
  • public-patron-profile
  • public-holdings-items
  • shared

Code formatting

Prettier formats the code, with sorted imports (on save in VS Code). The CI fails when a file is not formatted:

pnpm run format         # format the code
pnpm run format:check   # check the formatting, as the CI does

Further help

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

Translations

Commands:

  • pnpm run admin_extract_messages: will extract all strings in admin project and put them in the translations/messages.json source file
  • pnpm run admin_update_catalog: will extract all strings and put them into the de/en/es/fr/it/nl/ar/ta/uk json files for translation
  • pnpm run public-search_extract_messages, pnpm run public-search_update_catalog: same as admin, but for public-search project
  • pnpm run shared_extract_messages, pnpm run shared_update_catalog: same as admin, but for shared project
  • pnpm run extract_messages: launches extract-messages commands for all projects
  • pnpm run update_catalog: launches update-catalog commands for all projects

About

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

Resources

Stars

10 stars

Watchers

8 watching

Forks

Releases

Packages

Used by

Contributors

Languages