Skip to content

Commit 4593fbe

Browse files
committed
Update CONTRIBUTINGs and READMEs for Node and npm versions
Signed-off-by: Florian Hotze <[email protected]>
1 parent fb97f2a commit 4593fbe

File tree

5 files changed

+20
-8
lines changed

5 files changed

+20
-8
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,12 @@ You find the following repository structure:
5656

5757
In most cases, you **don't** need a Java development environment for UI development.
5858

59-
Instead, make sure you have NodeJS 16.14 (HABot: 12.16) or later and npm 8.6 (HABot: 6.14) or later installed.
59+
Instead, you need NodeJS and npm installed, you'll learn about the required versions later.
6060

61-
62-
Then identify in the `bundles` directories where the frontend code is - for instance, for the main UI it is `bundles/org.openhab.ui/web/`.
63-
Then follow the instructions in the specific add-on's `CONTRIBUTING.md` file to get started. In the main UI's case, it is located in [bundles/org.openhab.ui/CONTRIBUTING.md](https://github.com/openhab/openhab-webui/blob/master/bundles/org.openhab.ui/CONTRIBUTING.md). In many cases it will involve executing some `npm` commands to install dependencies and start a development server.
61+
Then identify in the `bundles` directories where the frontend code is - for instance, for the Main UI it is `bundles/org.openhab.ui/web/`.
62+
Then follow the instructions in the specific add-on's `CONTRIBUTING.md` file to get started, e.g. install the correct versions of NodeJS and npm.
63+
For Main UI, it is located in [bundles/org.openhab.ui/CONTRIBUTING.md](https://github.com/openhab/openhab-webui/blob/master/bundles/org.openhab.ui/CONTRIBUTING.md).
64+
In many cases it will involve executing some `npm` commands to install dependencies and start a development server.
6465

6566
However, if you want to compile the final `.jar` add-ons, we have assembled some step-by-step guides for different IDEs on our developer documentation website:
6667

bundles/org.openhab.ui.basic/CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
## Contributing
22

3-
Javascript linting, compressing and LESS compilation is handled through Gulp. Therefore, please run `gulp` instead of changing compressed CSS/JS manually. Default Gulp task will also check the code using ESLint.
3+
You need NodeJS 18.17.0 or later and npm 9.8.1 or later installed.
4+
5+
Javascript linting, compressing and LESS compilation is handled through Gulp.
6+
Therefore, please run `gulp` instead of changing compressed CSS/JS manually.
7+
Default Gulp task will also check the code using ESLint.
48

59
Installing build dependencies:
610

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing to HABot
2+
3+
You need NodeJS 12.16 or later and npm 6.14 or later installed.

bundles/org.openhab.ui.habpanel/CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ redirect you, if necessary.
1414

1515
## Build Environment
1616

17-
It is assumed you have ```npm```, ```bower``` and ```gulp``` available; if not,
18-
check their respective docs.
17+
You need NodeJS 16.14 or later and npm 8.6 or later installed.
18+
19+
It is assumed you have `npm`, `bower` and `gulp` available;
20+
if not, check their respective docs.
1921

2022
To build the Javascript part of HABPanel, navigate to the ```web/``` subfolder, then:
2123
1. Run ```npm install```

bundles/org.openhab.ui/CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ The repository for web user interfaces, including this project, is located at <h
88

99
This project is built using [Vue.js](https://vuejs.org/), [webpack](https://webpack.js.org/) and [Framework7](https://framework7.io).
1010

11-
You need Node 18.18.0 or later and npm 9.8.1. Change to the `web` directory, gather the necessary dependencies with `npm install` then the scripts below will be available.
11+
You need Node 18.18.0 or later and npm 9.8.1 or later installed.
12+
13+
Change to the `web` directory, gather the necessary dependencies with `npm install` then the scripts below will be available.
1214

1315
## NPM Scripts
1416

0 commit comments

Comments
 (0)