Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/balmoral/opal-highcharts
Ruby wrapper for Highcharts and Highstock javascript libraries
https://github.com/balmoral/opal-highcharts
Last synced: 2 months ago
JSON representation
Ruby wrapper for Highcharts and Highstock javascript libraries
- Host: GitHub
- URL: https://github.com/balmoral/opal-highcharts
- Owner: balmoral
- License: mit
- Created: 2015-08-05T01:38:47.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-11T20:37:35.000Z (about 8 years ago)
- Last Synced: 2024-04-24T15:23:56.185Z (9 months ago)
- Language: Ruby
- Size: 59.6 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-opal - Opal Highcharts - Ruby wrapper for Highcharts and Highstock javascript libraries (Uncategorized / Uncategorized)
README
## Ruby wrapper for Highcharts.js and Highstock.js charting libraries
The goal of this project is to wrap the Highcharts and Highstock APIs in Opal, providing a simple Ruby interface to Highcharts' functionality.
To find out more about Highcharts, check out these links:
* Highcharts: http://www.highcharts.com/products/highcharts
* Highcharts Demos: http://www.highcharts.com/demo
* Highstock Demos: http://www.highcharts.com/stock/demo
To find out more about Opal, go to http://opalrb.org
## Installation
Install opal-highcharts from RubyGems:
```
$ gem install opal-highcharts
```
Or include it in your Gemfile for Bundler:
```ruby
gem 'opal-highcharts'
```
## Cloning this repository
```
$ git clone https://github.com/balmoral/opal-highcharts
```
## Getting Started
### Usage
`opal-highcharts` can be added to your opal application sources using a standard require:
```ruby
# app/application.rb
require 'opal'
require 'opal/highcharts'
```
> You need to bring your own `highcharts.js` or `highstock.js` file.
> If you require Highstock functionality use `highstock.js`, which includes Highcharts.
> If you only require Highcharts functionality use `highcharts.js`.
> Download from
> http://code.highcharts.com/highcharts.js or
> http://code.highcharts.com/stock/highstock.js
> and put the file in `app/` or whichever directory you are compiling assets from.
## To do
* Implement Highstock features
* Documentation
* Testing
## Getting involved
To contribute to this project, follow the steps below.
1. Fork the repo ( https://github.com/balmoral/opal-highcharts/fork )
2. Create your feature branch (`git checkout -b new-branch`)
3. Commit your changes (`git commit -am 'description of commit'`)
4. Push to the branch (`git push origin new-branch`)
5. Create a Pull Request
Contributions welcome.
## Licenses
### Highcharts
Free for non-commercial use.
See http://www.highcharts.com/ for details.
###opal-highcharts
MIT Licence.
See LICENSE.txt