https://github.com/codevise/pageflow-chart

Page type for embedded datawrapper charts.
https://github.com/codevise/pageflow-chart

Last synced: 5 months ago
JSON representation

Page type for embedded datawrapper charts.

• Host: GitHub
• URL: https://github.com/codevise/pageflow-chart
• Owner: codevise
• Created: 2014-07-22T08:36:53.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2025-09-24T10:15:22.000Z (9 months ago)
• Last Synced: 2025-10-21T02:49:00.822Z (8 months ago)
• Language: Ruby
• Size: 211 KB
• Stars: 0
• Watchers: 6
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# Pageflow Chart

[![Gem Version](https://badge.fury.io/rb/pageflow-chart.svg)](http://badge.fury.io/rb/pageflow-chart)

[![Build Status](https://github.com/codevise/pageflow-chart/workflows/tests/badge.svg)](https://github.com/codevise/pageflow-chart/actions)

Page type showing scraped svg diagramms from Datawrapper.

## Installation

Add this line to your application's Gemfile:

    # Gemfile

    gem 'pageflow-chart'

Mount the engine:

    # config/routes.rb

    mount Pageflow::Chart::Engine, at: '/chart'

Register the plugin:

    # config/initializers/pageflow.rb

    config.plugin(Pageflow::Chart.plugin)

Include javascript/stylesheets:

    # app/assets/javascripts/pageflow/application.js

    //= require "pageflow/chart"

    # app/assets/javascripts/pageflow/editor.js

    //= require pageflow/chart/editor

    # app/assets/stylesheets/pageflow/application.scss;

    @import "pageflow/chart";

    # app/assets/stylesheets/pageflow/editor.scss;

    @import "pageflow/chart/editor";

    # Adding basic style to your theme

    # app/assets/stylesheets/pageflow/themes/default.scss

    @import "pageflow/chart/themes/default";

Execute `bundle install`. Then Install and run migrations:

    rake pageflow_chart:install:migrations

    rake db:migrate SCOPE=pageflow_chart

## Create Proxy

Create a proxy (via Apache, Nginx, ...) from your domain to your configured

`S3_HOST_ALIAS` to circumvent the same-domain policy. Configure this

in your Pageflow Chart initializer `config/initializers/pageflow_chart.rb`.

Example conf snippet for Nginx. Add this `location` block inside every `server` that's being used by Ruby/Rails.

    location /datawrapper/ {

      proxy_pass http://bucketname.s3-website-eu-west-1.amazonaws.com/;

      proxy_redirect http://bucketname.s3-website-eu-west-1.amazonaws.com/ $scheme://$host/datawrapper/;

    }

Normally you will do in two servers: the one that has `listen 80` in it

and the other one which has `listen 443' in it (for https). This is needed

so the charts can be servered from the same origin a the entry.

## Configuration

Configure Pageflow Chart by creating an initializer in your app

`config/initializers/pageflow_chart.rb`.

Example:

    Pageflow::Chart.configure do |config|

      config.scraped_sites_root_url = '/datawrapper'

      # Allow scraping charts from custom account URLs

      config.supported_hosts << 'http://mycustom.datawrapper.de'

      # Uncomment to inject custom css into iframe.

      # config.use_custom_theme = true

    end

Also see `lib/pageflow/chart/configuration.rb` for the additional options.

## Troubleshooting

If you run into problems while installing the page type, please also

refer to the

[Troubleshooting](https://github.com/codevise/pageflow/wiki/Troubleshooting)

wiki page in the

[Pageflow repository](https://github.com/codevise/pageflow). If that

doesn't help, consider

[filing an issue](https://github.com/codevise/pageflow-chart/issues).

## Contributing Locales

Edit the translations directly on the

[pageflow-chart](http://www.localeapp.com/projects/public?search=tf/pageflow-chart)

locale project.