arlas-web-core

Core Service Library for ARLAS Web App

Usage no npm install needed!

<script type="module">
  import arlasWebCore from 'https://cdn.skypack.dev/arlas-web-core';
</script>

README

ARLAS Web Core

Build Status npm version

arlas-web-core is a typescript library that provides :

  • A collaborative search service (CSS) that coordinates the ARLAS-web-contributors collaborations.
  • A configuration service that allows to read and parse a configuration file (that is used by the CSS & other services in ARLAS-wui-toolkit).

Install

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

$ npm install --save arlas-web-core

Documentation

Please find the documentation 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-core

Move to the folder

$ cd ARLAS-web-core

Install all the project's dependencies

$ npm install

Build the project with tsc :

$ 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 new feature is implemented.
  • z : Incremented as soon as the ARLAS-web-core implementation receives a fix or an enhancement.

For the versions available, check the ARLAS-web-core 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