kacpermadej / highcharts-utils

Highcharts Utilities

Visual testing and debugging tools for Highcharts.

Installation

Run npm install

Start server

• OSX: sudo node server
• Windows: Open a CLI with administrator priviliges and run node server

This will start a proxy server on port 80, start servers on localhost:3030 and localhost:3031 (configurable ports) and set up virtual hosts for utils.highcharts.local and code.highcharts.local respectively.

Unobtrusive utils

If you don't want to block port 80 and don't need the virtual hosts, run npm start and open http://localhost:3030.

Debugging the utils application

Run nodemon ./bin/www and open http://localhost:3030.

Usage

The default settings for these options are specified in the config.json file. For a detailed explanation of these options, refer to the settings-help file. To change the options at the runtime use "Session settings" menu (the gear icon) on the "View samples" subpage. The options that are handled at the runtime:

• codeWatch
• compileOnDemand
• emulateKarma
• useESModules
• useMinifiedCode

CLI arguments are available for preview with npx highcharts-utils --help, or an equivalent command. The options that are handled at the runtime set through "Session settings" (explained above) have precedence over the CLI arguments.

See highcharts/samples for description of how the samples are set up and how to use the utils.

The server code.highcharts.local is serving files locally from the /code folder in your highcharts repository. The folder /code is created by running gulp in the root folder of the Highcharts repo. See config.json for pointing to the location of your cloned Highcharts repo.

Optional: Using with HTTPS

Enabling HTTPS makes it easier to test things on 3rd party pages that use SSL.

OSX

Run cd certs && chmod 755 osx.create.ssl.certs.sh && ./osx.create.ssl.certs.sh from the project directory. Requires that homebrew is installed.

Next you need to whitelist the certificate. Open the /certs folder, and double click the highcharts.local.csr. For the Keychain (nøkkelring) option, select System, then Add. Note that the change only takes effect after the next system login.

If you're having problems running the secure server on the Mac, see this Stack Overflow question.

Windows

Run cd certs && ./win.create.ssl.certs.sh from the project directory. Requires that OpenSSL is installed. Press Enter to use the suggested default values for the certificate.

Next you need to install the certificate to whitelist it. Open the cert folder, and double click the highcharts.local.csr, select "Install Certficate...", and select "Next" until finished to let Windows choose the default settings. Note that the change only takes effect after the next system login.