# AxisJS [![Build Status](https://travis-ci.org/times/axisJS.svg?branch=master)](https://travis-ci.org/times/axisJS) [![codecov.io](http://codecov.io/github/times/axisJS/coverage.svg?branch=master)](http://codecov.io/github/times/axisJS?branch=master) [![Documentation status](http://inch-ci.org/github/times/axisJS.svg?branch=master)](http://inch-ci.org/github/times/axisJS)  [![Join the chat at https://gitter.im/times/axisJS](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/times/axisJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
### 2014 [Ændrew Rininsland](http://www.github.com/aendrew) for [The Times and Sunday Times](http://www.github.com/times)

AxisJS is a light [Angular](http://angularjs.org)-based app for generating charts. It combines with
the [AxisWP](http://www.github.com/times/Axis) WordPress plugin to
add rich charting capabilities to WordPress.

**[Live demo of AxisJS here](http://times.github.io/axisJS/#/)**

AxisJS is built atop the [Yeoman](http://github.com/yeoman) [Gulp-Angular](http://github.com/Swiip/generator-gulp-angular)
generator and currently makes use of C3 to build charts.

AxisJS owes a huge debt of gratitude to [Quartz](http://www.qz.com)'s [ChartBuilder](http://quartz.github.io/ChartBuilder),
from where much of the PNG/SVG output code is taken (in addition to some of the interface design). However, Axis is more extensible and intended to be used for online interactive graphics.

### Bower

`bower install axisjs`

### Project goals

1. Enable easy integration of various D3-based frameworks into a simple interface
2. Enable a wide array of data input methods
3. Be modular enough to allow charting frameworks to easily be replaced
4. Allow for straight-forward customisation and styling
5. Allow for easy integration into existing content management systems
6. Allow journalists to easily create charts that are embeddable across a wide array of devices and media


### To build

1. `npm install`
2. `bower install`
3. `grunt build`

### Modifying

The source is in the `src/` folder, which gets built to `dist/` when you do `gulp build`.
When working on it, run `gulp serve` to invoke a light HTTP server that auto-reloads the page
when you save a file. Styles are in Sass at `src/app/index.scss`.

### Contributing

Please do a new feature branch when forking and squash your commits before
making a pull request. Pull requests welcomed and encouraged. I especially welcome
any documentation or unit testing PRs!

### API Docs

Inline documentation is in ngDoc format and gets built to `docs` during `grunt build`.
View API docs online [here](http://times.github.io/axisJS/docs/).

### Roadmap/ToDos

- [x] Abstract chart configuration into a provider so that `app/scripts/directives/buildchart.js`
      and `app/scripts/directives/exportchart.js` aren't so tightly bound to C3
- [x] **ALL** the unit tests
- [x] Documentation and cleanup of `buildchart.js` and `exportchart.js`
- [x] Abstract each output format into factories so more can be modularly added
- [ ] Abstract out vendor functionality — i.e., make the colour picker replaceable
- [x] Create an external config file with settings like colour scheme
- [x] Improve inline documentation
- [x] Make adding categorical axes more straight-forward
- [ ] Create adapters for [nvd3](http://www.nvd3.org) and other SVG-based charting libraries.
- [ ] Componentise so it can be easily dropped into any CMS or app