infra-geo-ouverte
IGO2 Library
This repository is home to the IGO2 Library on which IGO2 is built. IGO2 and this library are open source projects using Angular, Angular Material and OpenLayers. While IGO2 is mapping oriented, this library can easily serve other purposes as it contains many components and services that may benefit any web application.
Description
IGO2 library is divided into several elements:
@igo2/utils : Basic utilies without dependency (ex: base64, clipboard, uuid)
@igo2/core : Element affecting the core of the application (ex: config, language, message, media, request)
@igo2/common : Library containing reusable components (ex: clickout, drag-drop, list, panel, spinner, table)
@igo2/auth : Library grouping the authentication and security module
@igo2/geo : Library containing the geomatic components. Depends on Openlayers.
@igo2/context : Library of components uniting @igo2/geo and @igo2/auth
@igo2/integration : Library integrate basic components
Demo
User Installation
The latest release of IGO2 Library can be used and installed from npm.
Example:
npm install --save @igo2/core
npm install --save @igo2/common
- See the demo code for examples of simple use.
For developers
Developer Installation
Require:
| IGO2 version | Node version |
|---|---|
| >= 16.x | >= 18.10.0 |
| >= 1.15.x | >= 16.19.x |
| >= 1.13.x | >= 14, <= 16 |
| 1.5.x | >= 12, <= 14 |
| < 1.5.x | >= 8, <= 11 |
| 0.x.x | >= 6, <= 10 |
If you want to develop in IGO2 Library, it can be installed by:
- Clone current repository: using
git clone https://github.com/infra-geo-ouverte/igo2-lib.git - Navigate to the folder igo2-lib :
cd igo2-lib/ - Install dependencies by running
npm install - Build librairies:
npm run build.libs - Start form npm
npm start.demo(or you can run the VsCode config (Launch Demo)) - Open your browser at http://localhost:4200/
Build
Run npm run build.libs to build the whole project. The build artifacts will be stored in the dist/ directory.
Running tests
Run npm run test.libs to execute the tests