@sedoo/unidoo

unidoo

see Documentation

Library

For users

How to integrate Unidoo in a project

1. Install the module

npm i @sedoo/unidoo

2. In you main.js add the following lines

import { Unidoo, UnidooKeycloak } from "@sedoo/unidoo";
Vue.use(Unidoo, { vuetify, axios, iconfont: 'mdi' }); // à mettre après Vue.use(VueAxios, axios);
Vue.use(UnidooKeycloak, { axios }); // à mettre après Vue.use(VueAxios, axios);

NB :

• Unidoo : bibliothèque de composants vuetify
• UnidooKeycloak : wrapper keycloak

For developers

Warning

Naming convention: the main branch is called main and not master

How to publish the library in NPM ?

The publishing of the library is automated by the Gitlab pipeline. No other method should be used.

Gitlab pipeline is triggering after each git push --tags on the main branch :

• the documentation of the library is built and deployed as a gitlab page
• the library is built and deployed to @sedoo/unidoo npm registry

If the build is successful, the system will publish it on NPM using the version number indicated in the package.json file. If this version corresponds to an already published version, the build will stop here. Else, the version is published.

Hence, to publish an new version, it is important to update the number in the package.json file.

Tips to prevent errors in the publishing process in the pipeline:

• use the npm run build --fix command to test the build locally before pushing the code to the repository and fix the linting errors
• use the npm run docs:build command to test the documentation build locally before pushing the code to the repository Nevertheless if the pipeline fails, check the logs in the Gitlab pipeline console to find the error : Example of error : error Unexpected console statement no-console means that there is a console.log() statement in the code. Resolve action : Remove console.log. However if log are necessary a workaround can be to implement infoLog() and errorLog() functions in the code of the component (like in the UnidooMapGeoFeatures) to replace console.log() and console.error() statements.

Then run the demo locally like bellow to check that everything is ok before merging and pushing the code on the main branch of the repository:

Demo application

On developement station

To run the demo locally:

npm run docs:dev

Demonstration on the Web in Wordpress after publishing

Live demonstration