Skip to content

mrclapham/Spirograph

Repository files navigation

Spirograph

A JavaScript spirograph

Build Status

To install via npm: $ npm install spirograph --save or simply use the compiled version in the dist folder, 'dist/SpirographJs.js'.

If you pull the repository you will need to build the compiled version in dist. run: $ npm run build

There is a demo vesion which may be viewed at https://gc-spirograph.herokuapp.com/

###API Documentation

Api Documentation may be found here

-- To run tests install the Karma command line interface as a global: $ npm install -g karma-cli then run via $ karma start

To contribute use semantic-release for commits: $ npm install -g semantic-release-cli

To make semantic release commits simpler use Commitizen: $ npm install -g commitizen