open-index/open-npm huggingface dataset:
npm package: @nataliia-dev/candlestick-charts
Description: Candlestick chart that graphically represents the price moves of an asset for a given timeframe. As the name suggests, it’s made up of candlesticks, each representing the same amount of time. In the current implementation it is possible to filter by vario
Latest version: 1.1.1

## Introduction
Candlestick chart that graphically represents the price moves of an asset for a given timeframe. As the name suggests, it’s made up of candlesticks, each representing the same amount of time.
In the current implementation it is possible to filter by various intervals, e.g. 1 day, 3 days, 1 week etc
It is also possible to filter items by date range.
BUY and SELL signals are generated by picking a random item in the chart. It will be recalculated on any filter change.
Please see screenshots for more references.  

## Install
```sh
npm install @nataliia-dev/candlestick-charts
```
[@nataliia-dev/candlestick-charts npm package](https://www.npmjs.com/package/@nataliia-dev/candlestick-charts)

## Usage

### Chart Component
```typescript jsx
import { KlineCandlestickChart, ApiProvider } from '@nataliia-dev/candlestick-charts'

const Example = () => {
  return (
    <KlineCandlestickChart apiProvider={ApiProvider.Binance} pair="BTCUSD" />
  );
};
```

### Chart Component Props
```typescript
type Props = {
  // apiProvider - [Optional] - Api to fetch data from. Currently only Binance is available.
  // default value - ApiProvider.Binance
  apiProvider?: ApiProvider;
  // pair - [Optional] - name of the two assests which is compared to each other
  // default value - "BTCUSD" 
  pair?: string;
};
```

## Screenshots

#### Default state
![candlestick-chart](https://github.com/nataliia-v/candlestick-charts/assets/46761205/bcd61966-0f4c-4ba2-9461-d8c9a6e3a534)

#### Filters applied & tooltip presentation
![image](https://github.com/nataliia-v/candlestick-charts/assets/46761205/21709603-d753-46de-8b56-802b56390759)

# Modern.js Package

## Setup

Install the dependencies:

```bash
npm run install
```

## Get Started

Run and debug the module:

```bash
npm run dev
```

Run test cases:

```bash
npm run test
```

Build the module for production:

```bash
npm run build
```

Enable optional features:

```bash
npm run new
```

Other commands:

```bash
npm run lint         # Lint and fix source files
npm run change       # Add a new changeset
npm run bump         # Update version and changelog via changeset
npm run release      # Release the package
```

For more information, see the [Modern.js Module documentation](https://modernjs.dev/module-tools/en).