IMPORTANT: This project was transitional (it was only needed during the code contribution to Eclipse Sirius). It is archived and then will be removed completely. Please see https://github.com/eclipse-sirius/sirius-components instead.

sirius-components

Eclipse Sirius Web is a framework to easily create and deploy studios to the web. We keep the principles which made the success of Eclipse Sirius Desktop and make them available on a modern cloud-based stack.

This repository, sirius-components, contains the building blocks from which Sirius Web applications are built:

• frontend contains reusable React components used to build the application’s UI;

• backend contains the Spring Boot projects from which the corresponding backend is built.

To actually build and run a complete example application, see the sirius-web repository which contains a complete example of a Sirius Web modeler built using these components.

Building

To build the components in this repository, you will need the following tools installed:

• git

• Java 11 (Java 12 or later are currently not supported)

• Apache Maven 3.6.3

• Recent versions of Node and NPM: in particular, Node >= 14.

• rollup (npm install -g rollup)

• yalc (npm install -g yalc): optional, only needed for local publication of the frontend components

Build steps:

1. Clone the Sirius EMF JSON repository (the sirius-components backend depends on it):

   git clone https://github.com/eclipse-sirius/sirius-emf-json.git

2. Build and install (locally) the EMF JSON JARs:

   cd sirius-emf-json
   mvn clean install -f releng/org.eclipse.sirius.emfjson.releng/pom.xml

3. Clone the sirius-components repository

   git clone https://github.com/eclipse-sirius/sirius-components.git

4. Build the frontend components:

   cd sirius-components/frontend
   npm install
   npm run build

5. Optional: publish the built version of the frontend components locally. Still from sirius-components/frontend:

   yalc publish

6. Build the backend components:

cd sirius-components/backend
mvn clean install

License

Everything in this repository is Open Source. Except when explicitly mentioned otherwise (e.g. for some resources likes images), the license is Eclipse Public License - v 2.0.