Skip to content

Commit 60997e0

Browse files
authored
Small readme changes (graduta#30)
1 parent 44a9f1b commit 60997e0

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# WebUI-Workshop 2023
1+
# WebUI-Workshop 2024
22

3-
- [WebUI-Workshop 2023](#webui-workshop-2023)
3+
- [WebUI-Workshop 2024](#webui-workshop-2024)
44
- [Overview](#overview)
55
- [Tutorials to follow before workshop day](#tutorials-to-follow-before-workshop-day)
66
- [Local Setup](#local-setup)
@@ -17,7 +17,7 @@
1717

1818
# Overview
1919

20-
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).
20+
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, RCT).
2121

2222
At the end of the workshop the students should have successfully built a web project based on [@aliceo2/web-ui](https://www.npmjs.com/package/@aliceo2/web-ui).
2323

@@ -29,11 +29,12 @@ The following tutorials are considered to be useful to skim through or complete
2929
- Sequalize for Databases: https://sequelize.org/docs/v6/getting-started/
3030
- MithrilJS: https://mithril.js.org/
3131
- Docker: https://www.docker.com/101-tutorial/
32+
- CSS Flexbox Guide: https://css-tricks.com/snippets/css/a-guide-to-flexbox/
3233

3334
# Local Setup
3435

3536
### NodeJS & NPM
36-
[NodeJS](https://nodejs.org/en/) required version `18`/ `20`. </br>
37+
[NodeJS](https://nodejs.org/en/) required version `>=20`. </br>
3738
Downloading the package from nodejs website will install both NodeJS and NPM.
3839

3940
Check installation was successful:
@@ -46,9 +47,11 @@ Install an editor of your choice. For this workshop, presenters will be using [V
4647
# Build a project with WebUI - Framework
4748

4849
## 0. Intro
49-
The AliceO2 user applications are built as web projects based on a common UI Framework [@aliceo2/web-ui](https://www.npmjs.com/package/@aliceo2/web-ui).
50+
The AliceO2 user applications are built as web projects based on a common UI Framework [@aliceo2/web-ui](https://www.npmjs.com/package/@aliceo2/web-ui) which provides functionality for both front-end and back-end.
5051

51-
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](https://github.com/AliceO2Group/WebUi/blob/dev/Framework/docs/guide/template-engine.md)
52+
All applications are built as SPAs (Single Page Applications).
53+
54+
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](https://github.com/AliceO2Group/WebUi/blob/dev/Framework/docs/guide/template-engine.md)
5255

5356
* Examples on how to build [Components](https://github.com/AliceO2Group/WebUi/blob/dev/Framework/docs/guide/components.md).
5457
* [Scaling your application](https://github.com/AliceO2Group/WebUi/blob/dev/Framework/docs/guide/scale-app.md)

docs/SETUP_WEBUI_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
1. Fork the repository and clone your forked version locally.
2-
2. Go to the directory of the project: `cd webui-workshop`
2+
2. Go to the directory of the project: `cd webui-workshop/2-3-4-Exercises`
33
4. Install the project dependencies via: `npm ci`. More dependencies will be installed during the exercises
44
5. Copy the configuration file: `cp config-default.js config.js`
55
6. Run: `node index.js`

0 commit comments

Comments
 (0)