arlas-d3

D3 components library for ARLAS Web App

Usage no npm install needed!

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

README

ARLAS-d3

Build Status npm version

About

ARLAS-d3 is a library that provides a set of d3 components : Charts .

Install

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

$ npm install --save arlas-d3

Documentation

Please find the documentation of all the d3 components here

Build

To build the project you need to have installed

  • Node version >= 8.0.0
  • npm version >= 5.2.0

Then, clone the project

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

Move to the folder

$ cd ARLAS-d3

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 a new component is added or a major/breaking change is occured
  • y : Incremented as soon as a parameter is added or modified
  • z : Incremented as soon as the ARLAS-d3 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 2.0 - see the LICENSE.txt file for details