Skip to content

arlas-web-contributors

ARLAS Web Contributors

Build Status npm version

arlas-web-contributors is a typescript library that fetches data from the ARLAS Exploration API and pass it to the different arlas-web-components.

Each ARLAS-web-component has its corresponding contributor.

A contributor also listens to the filters applied on the component and pass them to the other contributors. These collaborative contibutions are monitored by arlas-web-core

Install

To install this library in your npm web application, add the dependency in your package.json file.

$ npm install --save arlas-web-contributors

Documentation

Please find the documentation of all the contributors here.

Build

To build the project you need to have installed - Node version >= 16.3.0 - npm version >= 8.3.0

Then, clone the project

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

Move to the folder

$ cd ARLAS-web-contributors

Install all the project's dependencies

$ npm install

Build the project with tsc and gulp :

$ npm run build-release

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

Contributing

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

Versioning

We use SemVer for versioning : x.y.z.

  • x : Incremented as soon as the ARLAS-server API changes
  • y : Incremented as soon as a contributor has a new feature or a new contributor is implemented.
  • z : Incremented as soon as the ARLAS-web-contributors implementation receives a fix or an enhancement.

For the versions available, check the ARLAS-web-contributors releases.

Authors

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

License

This project is licensed under the Apache License 2.0 - see the LICENSE.txt file for details