README.md

VitamUI

Prerequisites

Tools

• Install JDK version >= 8
• Install Maven
  • Run this script to set it up
• Install Git
• Install Node.js and npm (with nvm)
  • Configure default registry: npm config set registry https://registry.npmjs.org/
• Python version 2.7 + pip for Python 2
• Install Ansible (see Ansible)

Ansible

Current version of VitamUI depends on Ansible version 2.7.0 in order to run installation scripts.

With VirtualEnv

In order not to interfere with more recent Ansible version, deploy a Python VirtualEnv in which you install Ansible 2.7.0:

• Check that VirtualEnv executable is installed: apt-get install python-virtualenv
• In a directory of your choice, create the virtual environment: virtualenv vitamUI-ansible
• Activate the environment: vitamUI-ansible/bin/activate

Without VirtualEnv

• First remove older versions of Ansible before re-installing it: pip uninstall ansible.
• Si une version d'ansible à été installée via apt-get install, il est nécessaire de la désinstaller : apt-get remove ansible

Common steps

• Install Ansible 2.7.0: pip install ansible==2.7.0
• Check the version of ansible: ansible --version

Il est possible que l'ajout du lien vers ansible dans le PATH et/ou qu'un redémarage soit nécessaire

Configuration

• Clone project and change ownership: sudo chown -R $USER vitam-ui/
• Build project using the "right" profile (see Maven profiles and Build)

For Vitam internal developers

• Build project using vitam profile (see Build for Vitam developers )
• Set up environment variables : SERVICE_NEXUS_URL and SERVICE_REPOSITORY_URL
• Copy files: access-external-client.conf, ingest-external-client.conf, keystore_ihm-demo.p12 and truststore_ihm-demo.jks into api/api-(iam|referential)/(iam|referential)-internal/src/main/config/dev-vitam/
• Redirect dev.vitamui.com URL defined in code to localhost : add this line 127.0.0.1 dev.vitamui.com to your hosts (/etc/hosts) file

For non Vitam developers

• Build Vitam locally

Common errors

/bin/sh: 1: /usr/bin/python: not found => Create symlink, for instance: sudo ln -s /usr/bin/python2.7 /usr/bin/python

Maven profiles

Without a profile, only Java projects are build.

Global Maven profiles

In order to build and package UI projects (i.e. Java backend & Angular frontend altogether), we use the plugin frontend-maven-plugin provided by com.github.eirslett.

dev

This profile is used to build the entire project for dev purposes, backend & frontend included.

• UI modules are packaged with both Java & Angular.
• Angular projects are built without optimization in order to reduce global build time.
• Jasmine Karma tests are launched with the headless chrome.

prod

This profile is used to build the entire project for prod purposes, backend/frontend included.

• UI modules are packaged with both Java & Angular.
• Angular projects are built with optimization.
• Jasmine Karma tests are launched with the headless chrome.

npm-publish

This profile is used to build, test & push npm packages to the npm repository.

It should be used in ui/ui-frontend-common to push the npm package of the common UI library.

rpm

This profile is used to build rpm packages.

Only Maven modules with rpm.skip = false in their properties are eligible.

rpm-publish

This profile is used to push the generated rpm package.