Skip to content

Latest commit

 

History

History
101 lines (62 loc) · 2.54 KB

README.md

File metadata and controls

101 lines (62 loc) · 2.54 KB
Raw

ARLAS web components :

Build Status npm version

About

ARLAS-web-components is an Angular library that provides a set of data analytics components.

Install

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

$ npm install --save arlas-web-components

Documentation

Please find the documentation of all the components here.

Build

To build the project you need to have installed

  • Node version ^16.0.0
  • npm version ^8.0.0
  • Angular CLI version ^14.2.13 
    $ npm install -g @angular/cli@^14.2.13

Then, clone the project

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

Move to the folder

$ cd ARLAS-web-components

Install all the project's dependencies

$ npm install

Build the project with ng :

$ npm run build-release

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

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

License

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

Acknowledgments

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