Skip to content

zwrawr/ldcharts

Repository files navigation

LDCharts

Build Status Coverage Status Documentation Status

this project is based off of code in ludumdare/ludumdare. Which is under the MIT lincence and written by zwrawr(me), local-minimum and mikekasprzak

Goals

  • Simple and small scoped charts
  • Small size

Development

Commands

# test with jest and enzyme
npm run test

# lint with eslint and stylelint
npm run lint

# cleans up atifacts
npm run clean

# build docs and bundle
npm run build

Directory Struture

  • ldcharts/
    • config/ dot files for configuration of various tools
    • coverage/ lcov report generated by jest, consumed by coveralls
    • build/ built artificats
      • docs/ code documentaion generated by esdoc
      • bundle/ transpiled, bundled and minified code
    • lib/ source code for all charts
    • test/ test files
      • __mocks__ browser, fetch and file mocks for jest
      • __setup__ setup files jest uses for enzyme and babel

Documentation

Code documentaion can be found here