seerline/clchart

<p align="center"><a href="https://seerline.github.io" target="_blank" rel="noopener noreferrer"><img width="100" src="https://seerline.github.io/logo.png" alt="ClChart logo"></a></p>

# clchart --  cymatics line chart

[![apm](https://img.shields.io/apm/l/vim-mode.svg?style=plastic)](https://opensource.org/licenses/MIT)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![npm](https://img.shields.io/npm/v/clchart.svg)](https://www.npmjs.com/package/clchart) [![Code Climate](https://img.shields.io/codeclimate/maintainability/seerline/clchart.svg)](https://codeclimate.com/github/seerline/clchart)

*Simple Cross-platform Stock Charts using the canvas element*

[HTML5 Demo](https://seerline.github.io/clchart/samples/)

[React Native Demo](https://github.com/seerline/react-native-clchart-demo)

[Wechat Applet Demo](https://github.com/seerline/wechat-applet-clchart-demo)

## Installation

### Manual Download

You can download the latest version of `clchart` from the [GitHub releases](https://github.com/seerline/clchart/releases/latest)

### npm

```bash
npm install clchart --save
```

### Build From Source

Cloning and building the base project:

```shell
git clone git@github.com:seerline/clchart.git
cd clchart
npm install

# Then to build
npm run build
```

## Documentation

[English docs](https://seerline.github.io/clchart/) (processing)

[中文文档](https://seerline.github.io/clchart/zh/) (编写中)

## Contributing

```shell
git clone https://github.com/seerline/clchart.git

npm install

npm run dev
```

## Screenshot

### pc demo

<img src="./screenshot/pc.png" alt="pc demo" width="100%" height="auto"/>

### web demo

<img src="./screenshot/web.png" alt="web demo" width="100%" height="auto"/>

### mina demo

<img src="./screenshot/mina.png" alt="mina demo" width="100%" height="auto"/>

### react native demo

<img src="./screenshot/reactnative.png" alt="reactnative demo" width="100%" height="auto"/>

## Todos

* [ ] karma test
* [ ] more web demo
* [ ] integrate [GCanvas](https://github.com/alibaba/GCanvas) for `react native android`
* [ ] [weex](https://github.com/apache/incubator-weex) demo
* [x] integrate wechat mina app

## License

ClChart is available under the [MIT license](https://opensource.org/licenses/MIT).