Papyrus Web

To build the application yourself you will need the following tools:

• Git, and a GitHub account

• To build the backend components:

  • Java 17

  • Apache Maven 3.6.3

  • Docker must be installed and running for some of the backend components tests to run.

• To build the frontend components:

  • LTS versions of Node and NPM: in particular, Node >= 18.7.0 is required along with npm >= 8.15.0.

For Windows users: Due to the Maximum Path Length Limitation of Windows, you may exceed the limit of 260 characters in your PATH. To remove this limitation, apply the this procedure with this command line in PowerShell (New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force), then active the longpath option in Git in a command line with administrator rights (git config --system core.longpaths true).

The backend of Papyrus Components depends on sirius-emf-json and sirius-components, which is published as Maven artifacts in GitHub Packages. To build `papyrus-web locally, you need a GitHub Access Token so that Maven can download the sirius-emf-json artifacts.

1. Create a personal token with a scope of read:package by following the GitHub documentation if you do not have one already.

   Once generated, a token cannot be displayed anymore, so make sure to copy it in a secure location.

2. Create or edit $HOME/.m2/settings.xml to tell Maven to use this token when accessing the Sirius EMF JSON repository:

   <?xml version="1.0" encoding="UTF-8"?>
   <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
     <servers>
       <server>
         <id>github-sirius-emfjson</id>
         <username>$GITHUB_USERNAME</username>
         <password>$GITHUB_ACCESS_TOKEN</password>
       </server>
       <server>
         <id>github-emfjson</id>
         <username>$GITHUB_USERNAME</username>
         <password>$GITHUB_ACCESS_TOKEN</password>
       </server>
       <server>
         <id>github-papyrus-sirius-uml2</id>
         <username>$GITHUB_USERNAME</username>
         <password>$GITHUB_ACCESS_TOKEN</password>
       </server>
       <server>
         <id>papyrus-uml-services</id>
         <username>$GITHUB_USERNAME</username>
         <password>$GITHUB_ACCESS_TOKEN</password>
       </server>
       <server>
         <id>github-sirius-components</id>
         <username>$GITHUB_USERNAME</username>
         <password>$GITHUB_ACCESS_TOKEN</password>
       </server>
     </servers>
   </settings>

   Be sure to replace $GITHUB_USERNAME with your GitHub user id, and $GITHUB_ACCESS_TOKEN with the value of your acess token done in the previous step.

   The id used in your settings.xml must be the ones mentioned above to match what is used in the POMs.

3. Create or edit $HOME/.npmrc and add the following line:

   //npm.pkg.github.com/:_authToken=$GITHUB_ACCESS_TOKEN

   Again, be sure to replace $GITHUB_ACCESS_TOKEN with the value of your access token.

Build steps:

1. Clone the Papyrus Web repository papyrus-web

2. Build the frontend (from the frontend subfolder of Papyrus web main location):

   npm ci
   npm run build

1. Install the frontend artifacts as static resource to be served by the backend. From the root directory of the repository:

   mkdir -p backend/papyrus-web-frontend/src/main/resources/static
   cp -R frontend/papyrus-web/dist/* backend/papyrus-web-frontend/src/main/resources/static

2. Build the backend (from the backend subfolder of Papyrus web main location):

   mvn clean verify

   or to ignore the basic tests:

or to launch all tests (take around 7 hours):

+

The result is a ready-to-run, Spring Boot "fat JAR" in backend/papyrus-web/target/papyrus-web-<VERSION>.jar. Refer to the instructions in the "Quick Start" section above to launch it.

Here are instructions that new papyrus web developer could follow in order to set up his/her development environment.

Backend set up

<classpathentry kind="output" path="target/classes"/>

Frontend set up

Launch Application as a developer

The header of each file should contain the following copyright block:

For instance a file contributed by Obeo funded by CEA LIST project should contain the following header:

For instance, a class contributed by Arthur should have the following header: