Setting up a development environment

This guide is useful if you want to modify the core CardKit library, or find out more about how it works internally. If you want to build your own instance of CardKit, take a look at the README for example configurations for browsers (via <script> tag), browsers (via a bundler like Webpack or Browserify), and servers (via Node.js).

Getting up and running with a development version of CardKit is simple.

• Clone this repository: $ git clone https://github.com/times/cardkit
• Move into the directory: $ cd cardkit
• Install npm dependencies: $ npm install

This will allow you to serve the base libraries locally.

Common tasks

• Run local development server on port 9000
  • $ npm start
• Build optimised versions of all output files
  • $ npm run dist
• Create documentation
  • $ npm run jsdoc
• Run unit tests
  • $ npm test

For more information, please see Application structure.