cluedin-integration

cluedin-integration

COMPONENT DESCRIPTION GOES HERE

Demo & Examples

Live demo: dervalp.github.io/cluedin-integration

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Installation

The easiest way to use cluedin-integration is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/cluedin-integration.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install cluedin-integration --save

Testing

npm test - run tests

npm run test:watch - watch tests

npm run test:coverage - generate test coverage report

Tests use Enzyme and snapshots. If the strucutre of a component changes the test may fail with a warning. To update the snapshot run npm run test:watch and press u for any outdated snapshot that can be updated.

Static type-checking

The project uses Flow Type to statically type check the code base. Type definitions are stored in flow-typed/cluedin/*.js. The project also uses the flow-typed project to provide type definitions for dependencies. Babel is used to strip out the type usage during the build process.

npm run typecheck - type check the code using flow

References:

Flow Flow-typed

Usage

EXPLAIN USAGE HERE

var CluedinIntegration = require('cluedin-integration');

<CluedinIntegration>Example</CluedinIntegration>

Properties

• DOCUMENT PROPERTIES HERE

Notes

ADDITIONAL USAGE NOTES

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).

License

PUT LICENSE HERE

Copyright (c) 2016 CluedIn.