Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sniperwolf/vis-gem

Wrap vis.js dependencies in Rails project.
https://github.com/sniperwolf/vis-gem

charts data-visualization javascript network rails ruby timeline visualization

Last synced: 29 days ago
JSON representation

Wrap vis.js dependencies in Rails project.

Awesome Lists containing this project

README

        

# vis.js on RoR

[![Gem Version](https://badge.fury.io/rb/vis-gem.svg)](https://badge.fury.io/rb/vis-gem)
[![Build Status](https://travis-ci.org/sniperwolf/vis-gem.svg?release=4.21.0.0)](https://travis-ci.org/sniperwolf/vis-gem)

A dynamic, browser based visualization library. **vis.js** is designed to be easy to use, to handle large amounts of dynamic data, and to enable manipulation of and interaction with the data. More info at [vis.js official website](http://visjs.org/).

`vis-gem` wraps **vis.js** dependencies in assets pipeline in Ruby on Rails (`=> 3.1`) projects.

[Actual](https://github.com/sniperwolf/vis-gem/releases/tag/4.21.0.0) **vis.js version** is `4.21.0` (released on 12 Oct 2017, see [release notes](https://github.com/almende/vis/releases/tag/v4.21.0)).

Thanks to [luciuschoi](https://github.com/luciuschoi/visjs-rails/) for the original idea.

## Installation

Add this line to `Gemfile`:

```ruby
gem 'vis-gem'
```

And then execute:

```bash
$ bundle
```

Or install it with:

```bash
$ gem install vis-gem
```

## Usage

1. Add this to `application.js` (`assets/javascripts/application.js`):

```ruby
//= require ...
//= require vis
//= require ...
```

2. Add this to `application.scss` (`assets/stylesheets/application.scss`):

```css
...
@import "vis";
...
```

3. And this to `config/initializers/assets.rb` (for assets):

```ruby
Rails.application.config.assets.precompile += %w( network/* )
```

See [original vis.js documentation](http://visjs.org/) for vis.js properties and methods.

## Changelog

- `v4.21.0.0`: Update with **vis.js** `v4.21.0` (released on 12 Oct 2017, see [release notes](https://github.com/almende/vis/releases/tag/v4.21.0)).
- `v4.20.0.1`: Update with **vis.js** `v4.20.1` (released on 4 Jul 2017, see [release notes](https://github.com/almende/vis/releases/tag/v4.20.1)).
- `4.20.0`: First Release with **vis.js** `v4.20.0` (released on 21 May 2017, see [release notes](https://github.com/almende/vis/releases/tag/v4.20.0)).

## Contributing

See [Contributing](CONTRIBUTING.md) document.

## License

(C) Fabrizio Fallico 2017, released under the [MIT license](LICENSE.md).