diff --git a/.nvmrc b/.nvmrc
index 98d9bcb75a685dfbfd60f611c309410152935b3d..ea3bf215cf43420e2696fa77fee851d61b214982 100644
--- a/.nvmrc
+++ b/.nvmrc
@@ -1 +1 @@
-17
+17.6.0
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 141738c3daf2c54f9beda90e37f8fb019a3650a4..4081892a06327e73e294db45c0b8d449a18f5c0a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,36 @@
# Contributing to piveau-hub-ui-modules
-As a contributor, here are the guidelines to follow.
+## Module development
+
+We are developing an npm package named `@piveau/piveau-hub-ui-modules`
+Component development takes place in the `src/modules` folder and
+all components that should be part of our npm package must be
+exported from there.
+
+The rest of the source code (outside `src/modules`) is a test app, which is a copy of Data Europa
+Piveau-Hub-UI and can be run with `npm run serve`. The basic idea is to take parts from
+the test app and isolate them in `src/modules`, then import them back into the test
+app just like you would from the published package:
+
+```
+import { MyComponent } from '@piveau/piveau-hub-ui-modules';
+```
+
+The workflow is as follows:
+
+* Develop your component in `src/modules`
+* Export the component in `src/modules/index.ts`
+* Import the component in the test app from `@piveau/piveau-hub-ui-modules`
+* When a new version should be published, do ONE of the following:
+ * Merge your feature branch into the develop branch. The CI will create a new version on the registry that can be imported as
+ `npm install @piveau/piveau-hub-ui-modules@develop`.
+ * Merge the develop branch into master. The CI will create a new version on the registry that can be imported as
+ `npm install @piveau/piveau-hub-ui-modules`.
+ * Increase the version number in `package.json` and run `npm run deploy` (you have to be logged into our paca npm registry).
+ THIS IS GENERALLY NOT RECOMMENDED! USE THE CI MECHANISM!
+
+Note that by the CI, NO new version of the modules is published if there are no fixes, new features or branking changes in the commits
+(see below how to indicate such changes in you commit messages).
## Branches
@@ -13,17 +43,6 @@ This allows us for a flow very similar to the git-flow:
* it is recommended to first implement test code changes on the `develop` branch and then merging it into `master` when ready.
* Issues/tickets should be worked on dedicated branches (and merged into `develop`/`master` when ready)
-## Coding rules
-
-### Source code
-
-To ensure consistency and quality throughout the source code, all code modifications must have:
-- No [linting](#lint) errors
-- A [test](#tests) for every possible case introduced by your code change
-- **100%** test coverage
-- [Valid commit message(s)](#commit-message-guidelines)
-- Documentation for new features
-- Updated documentation for modified features
### Commit message guidelines
diff --git a/README.md b/README.md
index e34401148ee2c5a498c51b288bc94975f5746f05..d136e52c058b09fd020197c93e7abfad64f361b2 100644
--- a/README.md
+++ b/README.md
@@ -1,48 +1,29 @@
# piveau-hub-ui-modules
-> Please use node version >= 14. Recommended is version 17.
+> Please use node version >= 14. Recommended is version 17.6.0.
This is a space to develop Vanilla piveau-hub-ui components.
-This project can be published as an npm package to our npm registry
+The contents of the modules folder can be published as an npm package to our npm registry
which can then be used in Piveau based projects to import the
-required parts.
-
-## Module development
-
-We are developing an npm package named `@piveau/piveau-hub-ui-modules`
-Component development takes place in the `src/modules` folder and
-all components that should be part of our npm package must be
-exported from there.
-
-The rest of the source code (outside `src/modules`) is a test app, which is a copy of Data Europa
-Piveau-Hub-UI and can be run with `npm run serve`. The basic idea is to take parts from
-the test app and isolate them in `src/modules`, then import them back into the test
-app just like you would from the published package:
-
-```
-import { MyComponent } from '@piveau/piveau-hub-ui-modules';
-```
-
-The workflow is as follows:
-
- * Develop your component in `src/modules`
- * Export the component in `src/modules/index.ts`
- * Import the component in the test app from `@piveau/piveau-hub-ui-modules`
- * When a new version should be published, increase the version number in `package.json` and run `npm run deploy` (you have to be logged into our paca npm registry)
-
-In order for imports from `@piveau/piveau-hub-ui-modules` in the test-app to work, that package must be accessible in the node_modules folder.
-There are two ways to achieve this:
-
- 1. Executing `npm run link-module` creates a symlink to the `src/modules` folder in node_modules.
- 2. Executing `npm run localdeploy` creates a compiled version of the modules folder in `dist` and copies it into node_modules`.
-
-The advantage of option 2 is that the package in node_modules is exactly the same as the published version will be.
-However development with that option requires repeated `npm run build` to update the package for the test-app.
-Option 1 does not require rebuilding so the development experience is simpler and faster.
+required parts. It also has a sample-app which can be run as follows:
+
+## Running the sample app
+
+1. Make sure you have a configuration file named `user-config.js` in the `config` folder.
+To start with, you can make a copy of `user-config.sample.js` and rename it to
+`user-config.js`.
+2. Run the command `npm ci` to install the dependencies.
+3. We must add the contents of the modules folders as a package dependency in node_modules. You have the following possibilities:
+ - Either you run `npm run localdeploy`; then the modules will be bundled and copied into node_modules. (Note that changes in the modules folders will cause no hot-reloads in this case -- you have to run this command over again to reflect changes.)
+ - Or: you run `npm run link-module`. A Symlink to the modules folder will then be added to node_modules. IMPORTANT: if you work under Windows, you must execute that command as admin! Alternatively you could also create the symlink by hand (adapt your path):
+ ```
+ MKLINK /d "D:\Dev\piveau\piveau-hub-ui-modules\node_modules\@piveau\piveau-hub-ui-modules" "D:\Dev\piveau\piveau-hub-ui-modules\src\modules"
+ ```
+4. Run the command `npm run serve` and open http://localhost:8080/ in your browser.
## Project setup
```
-npm install
+npm ci
```
### Test app compiles and hot-reloads for development
diff --git a/scripts/create_module_symlink.js b/scripts/create_module_symlink.js
index c21a5677d963e5cb266bd547ac6f5add50ad787d..0fbcffa8a667cb6fb04209677a1865caa8531a6d 100644
--- a/scripts/create_module_symlink.js
+++ b/scripts/create_module_symlink.js
@@ -1,7 +1,15 @@
const fs = require('fs');
const target = './node_modules/@piveau/piveau-hub-ui-modules';
-fs.symlinkSync("../../src/modules/", target, "dir");
-console.log("Module symlink created in node_modules");
+try {
+ fs.symlinkSync("../../src/modules/", target, "dir");
+ console.log("Module symlink created in node_modules");
+} catch(ex) {
+ console.log("Failed to create symlink in node_modules.")
+ if (process.platform === "win32") { // Operating under MS Windows
+ console.log("You need to execute this script as ADMIN.");
+ }
+}
+
diff --git a/scripts/ensure_module.js b/scripts/ensure_module.js
index 7a640ce727a7b378f42cfebaab1ae19a21717da7..fec7a52b09bac7e6d73182682c648fbde5a2d3f1 100644
--- a/scripts/ensure_module.js
+++ b/scripts/ensure_module.js
@@ -2,7 +2,11 @@ const fs = require('fs');
const target = './node_modules/@piveau/piveau-hub-ui-modules';
if ( ! fs.existsSync(target)) {
- fs.symlinkSync("../../src/modules/", target, "dir");
+ if (process.platform !== "win32") { // Not operating under MS Windows
+ fs.symlinkSync("../../src/modules/", target, "dir");
+ } else {
+ console.log("Please either run localinstall or run link-module as admin or copy a symlink to the modules folder into node_modules\\@piveau\\piveau-hub-ui-modules.");
+ }
}