# flowmon-ddos-visualizations-lib

> This template serves as a base for the visualization libraries.

Latest version **1.0.0** (published 2020-11-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install flowmon-ddos-visualizations-lib
pnpm add flowmon-ddos-visualizations-lib
yarn add flowmon-ddos-visualizations-lib
bun add flowmon-ddos-visualizations-lib
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-11-23 |
| First published | 2020-11-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 10 |
| Unpacked size | 11.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | ondrej.repa |

## Links

- npm: https://www.npmjs.com/package/flowmon-ddos-visualizations-lib
- npm.io page: https://npm.io/package/flowmon-ddos-visualizations-lib

## Dependencies (10)

- [color](https://npm.io/package/color.md) ^3.1.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [chart.js](https://npm.io/package/chart.js.md) ^2.9.4
- [d3-scale](https://npm.io/package/d3-scale.md) ^3.2.3
- [@nivo/bar](https://npm.io/package/@nivo/bar.md) ^0.63.0
- [@nivo/pie](https://npm.io/package/@nivo/pie.md) ^0.63.1
- [@nivo/waffle](https://npm.io/package/@nivo/waffle.md) ^0.63.1
- [@nivo/sunburst](https://npm.io/package/@nivo/sunburst.md) ^0.63.1
- [timelines-chart](https://npm.io/package/timelines-chart.md) ^2.10.0
- [chartjs-chart-treemap](https://npm.io/package/chartjs-chart-treemap.md) ^0.2.3

## Recent versions

- 1.0.0 (latest) — 2020-11-23

## README

# Library Template

This template serves as a base for the visualization libraries. 

## Development info 
*(remove this whole section later on, as well as the `rename` script)*


### Changing the lib name

In order to change the library name, run the `rename.sh` script: 

```bash
./rename.sh -n new-lib-name
```

The script changes the library name in all the necessary files (provided that the project has the initial example name!). 

### Deploying the library to the NPM repository

Set the following in the `.nprmc` file:
```
  registry=https://nexus.csirt.muni.cz/repository/tractor-npm-hosted/
  email=info@kypo.cz
  always-auth=true
  _auth=dHJhY3Rvci11cGxvYWRlcjozIStfPUdEW047WX1oczpfQm0=
```
  
In Windwos, you can set the properties via the console using the following command: 

```bash
npm set <key> <value>
```

such as: 

```bash
npm set registry https://nexus.csirt.muni.cz/repository/tractor-npm-hosted/
```

After you build the project, publish the package. The commands go as follows:
```bash
npm run build
npm publish --registry=https://nexus.csirt.muni.cz/repository/tractor-npm-hosted/
```


## Documentation

To run the detailed guide and component documentation, run the following in the root library directory:

```bash
npm install
npm start
```

By default, the application guide will be ready in the browser on  `http://localhost:6060/`

## Run example application locally

You can run an example app to see the expected visualization layout. Just run:

```bash
npm install
npm run build
cd example
npm start
```

By default, the example application will be ready in the browser on  `http://localhost:3000/`


## Install the library

When the library is deployed in the Nexus NPM repository, it can be used in a project via the following command:

```bash
npm install --save flowmon-ddos-visualizations-lib
```

## Usage

```jsx
import React, { Component } from 'react'

import Demo from 'flowmon-ddos-visualizations-lib'
import 'flowmon-ddos-visualizations-lib/dist/index.css'

class Example extends Component {
  render() {
    return <Demo />
  }
}
```

## License

Copyright © 2020 NC3 / TRACTOR

Licensed under the [MIT License](LICENSE)

---
_Source: https://npm.io/package/flowmon-ddos-visualizations-lib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._