Skip to content

graduta/webui-workshop

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WebUI-Workshop 2023

Overview

The purpose of this repository is to provide training material and step by step instructions for new joiners that are to work on ALICE GUIs. The workshop will be split in 3 main categories over the course of 2-3 days. It also gives an introduction to all ALICE projects (Bookkeeping, Control, InfoLogger, Quality Control).

At the end of the workshop the students should have successfully built a web project based on @aliceo2/web-ui.

Tutorials to follow before workshop day

The following tutorials are considered to be useful to skim through or complete before the workshop days.

Local Setup

NodeJS & NPM

NodeJS required version 18/ 20.
Downloading the package from nodejs website will install both NodeJS and NPM.

Check installation was successful:

  • node -v
  • npm -v

IDE

Install an editor of your choice. For this workshop, presenters will be using Visual Studio Code.

Build a project with WebUI - Framework

0. Intro

The AliceO2 user applications are built as web projects based on a common UI Framework @aliceo2/web-ui.

All applications are built as SPAs (Single Page Applications). A single-page application is a web application or website that interacts with the web browser by dynamically rewriting the current web page with new data from the web server. In order to do that, it was decided to make use of MithrilJS and its capabilities of building virtual nodes. MVC

Before starting the exercises, fork the repository and clone your fork locally.

References