About this repo:

This repository contains 4 Angular libraries and one demo Angular application.

The 4 libraries are:

• arlas-web-components: contains a set of graphical component to explore data such as : donuts, histograms, powerbars, resultlits, metrics, metrics table,..
• arlas-map: contains one map component dedicated to display ARLAS data. This component is cartographical-framework-free. The libarary also comes with a number of services. Those services provide cartographical interfaces that should be implemented according to your chosen map framework.
• arlas-maplibre: this library provides a maplibregl implementation of the arlas-map library.
• arlas-mapbox: this library provides a maboxgl implementation of the arlas-map library.

Note 1: arlas-maplibre and arlas-mapbox both have arlas-map as a dependency.

Note 2: As a consequence, you can install arlas-maplibre or arlas-mapbox directly without the need of installing arlas-map precedently.

The demo application is composed of several tabs. Each tab provides an example of one component of arlas-web-components library or an implementation of arlas-map library.

Artchitecture of arlas-map, arlas-maplibre and arlas-mapbox

• arlas-map provides the Angular components to be used in your apps.
• arlas-map components logic is declared in different services. Some are implemented when they don't depend directly on a cartographical framework. The rest are declared as abstract.
• The mapboxgl-js (v1.13) and maplibregl-js implementations are respectively coded in arlas-mapbox and arlas-maplibre libraries.

Install

To install these libraries in your npm Angular web app project add the dependency in your package.json :

For arlas-web-components:

$ npm install --save arlas-web-components

For arlas-map:

$ npm install --save arlas-maplibre

Or

$ npm install --save arlas-mapbox

Build

Prequesites:

To build the projects you need to have installed

• Node version ^18.19.1
• npm version ^10.0.0
• Angular CLI version ^18.2.12

  $ npm install -g @angular/cli@^18.2.12
  

Proceed to build

Clone the project

$ git clone https://github.com/gisaia/ARLAS-web-components

Move to the folder

$ cd ARLAS-web-components

Install all the projects dependencies

$ npm install

Build the project with ng :

For arlas-web-components

$ npm run build-components

For arlas-map

$ npm run build-map

For arlas-maplibre

$ npm run build-maplibre

For arlas-mapbox

$ npm run build-mapbox

The build artifacts will be generated in the dist/ directory.

Run

Check out the ARLAS web components by running the demo application of this library on a dev server :

$ ng serve 

Navigate to http://localhost:4200/.

The app will automatically reload if you change any of the source files.

Unit tests

$ ng test

Contributing

• Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use our own x.y.z versioning schema, where :

• x : Incremented as soon as the ARLAS-server API changes
• y : Incremented as soon as an ARLAS-web-components inputs or outputs change.
• z : Incremented as soon as the ARLAS-web-components implementation receives a fix or an enhancement.

Authors

• Gisaia - initial work - Gisaïa

See also the list of contributors who participated in this project.

License

These projects are licensed under the Apache License, Version 2.0 - see the LICENSE.txt file for details.

Acknowledgments

This repository has been initiated and is maintained by Gisaïa.