pka420 / react-stockcharts

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

react-stockcharts

Note: this repo is a fork of react-financial-charts Note: which is a fork of react-stockcharts

Charts dedicated to finance.

The aim with this project is create financial charts that work out of the box.

Features

  • integrates multiple chart types
  • technical indicators and overlays
  • drawing objects

Chart types

  • Scatter
  • Area
  • Line
  • Candlestick
  • OHLC
  • HeikenAshi
  • Renko
  • Kagi
  • Point & Figure

Indicators

  • EMA, SMA, WMA, TMA
  • Bollinger band
  • SAR
  • MACD
  • RSI
  • ATR
  • Stochastic (fast, slow, full)
  • ForceIndex
  • ElderRay
  • Elder Impulse

Interactive Indicators

  • Trendline
  • Fibonacci Retracements
  • Gann Fan
  • Channel
  • Linear regression channel

Installation

npm install @pka420/react-stockcharts

Documentation

Docs #WIP

Contributing

Refer to CONTRIBUTING.md

This project is NOT a mono-repo that uses Lerna to manage dependencies between packages. WE USE WEBPACK.

To get started run:

git clone https://github.com/pka420/react-stockcharts.git
cd react-stockcharts
npm install
npm run build

To start up a development server run:

npm run watch

Roadmap

  • Convert to typescript
  • Bump dependencies to latest
  • Remove React 16 warnings
  • Add CI
  • Fix passive scrolling issues
  • Implement PRs from react-stockcharts
  • Add all typings
  • Move examples to storybook
  • Add all series' to storybook
  • Split project into multiple packages
  • Fix issues with empty datasets
  • Correct all class props
  • Migrate to new React Context API
  • Remove all UNSAFE methods
  • Add documentation to docs
  • Add full test suite

LICENSE

WIP because I don't understand licences yet.

About

License:MIT License


Languages

Language:TypeScript 97.4%Language:JavaScript 2.6%