Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bluehalo/ngx-sentio

Components for integrating Sentio with Angular.io
https://github.com/bluehalo/ngx-sentio

Last synced: about 1 month ago
JSON representation

Components for integrating Sentio with Angular.io

Awesome Lists containing this project

README

        

# @asymmetrik/ngx-sentio

[![Build Status][travis-image]][travis-url]

[travis-url]: https://travis-ci.org/Asymmetrik/ngx-sentio/
[travis-image]: https://travis-ci.org/Asymmetrik/ngx-sentio.svg

> Angular.io components for Sentio.
> Provides directives for all Sentio visualization components. Supports Angular.io v13, Sentio v6, and D3 v7

## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Contribute](#contribute)
- [License](#license)

## Install
Install the package and its peer dependencies via npm:
```
npm install d3 @asymmetrik/sentio @asymmetrik/ngx-sentio
```

If you want to run the demo, clone the repository, perform an ```npm install```, ```npm run demo``` and then go to http://localhost:4200

To build and deploy the library, follow the demo instructions and then use ```npm run build``` and then go into the ```./dist/ngx-sentio/``` directory and run ```npm publish```

## Usage
TODO: Add usage examples

## API
TODO: Add full details of directives

## Contribute
PRs accepted. If you are part of Asymmetrik, please make contributions on feature branches off of the ```develop``` branch. If you are outside of Asymmetrik, please fork our repo to make contributions.

## License
See LICENSE in repository for details.