d3fc

d3fc

A collection of components that make it easy to build interactive charts with D3.

Installation

For details of installation and general usage, visit the project webpage.

Developing

npm, the package manager for Node.js, is used to manage the project's dependencies. Grunt, a JavaScript task runner, is used to test and build the project.

Initial Setup

• Download or clone this repository locally
• Ensure Node.js, which includes npm, is installed
• Ensure Grunt is installed:

npm install -g grunt-cli

• Navigate to the root of your local copy of this project and install the dependencies:

npm install

• Perform an initial build:

grunt

Grunt Tasks

The following Grunt tasks, found in Gruntfile.js, can be run from the command line. The most commonly used tasks to build and develop the project are:

• grunt build - generate the project's JavaScript and CSS files in the dist directory (at the root of the project); build the visual tests
• grunt dev - run grunt build, then grunt watch
• grunt dev:serve - same as grunt dev but also starts a web server for viewing the visual tests

Other tasks include:

• grunt check - run JSHint and JSCS checks
• grunt test - run unit tests and build the visual tests
• grunt watch - watch the source files and rebuild when a change is saved
• grunt serve - start a web server for viewing the visual tests
• grunt - check, test and build the project

Visual Tests

The project includes a number of unit tests, however, because these components are visual in nature, unit testing is not enough. This project contains a number of ad-hoc visual tests that are found within the visual-tests folder. The visual tests are compiled, via assemble, to create a simple website. To view this site, run grunt serve or a static server from the visual-tests\dist folder.

License

These components are licensed under the MIT License.