MarkLogic Treehouse (ml-treehouse)
This library provides a set of React components useful for building applications backed by a MarkLogic database.
Getting Started
Installation
npm install --save ml-treehouse
Contributing
Local Development of ml-treehouse
npm link ../ml-treehouse
# We need just one version of React
cd ../ml-treehouse
npm link ../host-for-ml-treehouse/client/node_modules/react
Tests
npm run test
To run the tests continuously as you change files:
npm run test:watch
To get a report on test coverage:
npm run test:coverage
open coverage/html/index.html
Code-Style and Linting
TODO: Describe ESLint, benefits of linting javascript, and the benefits of a common code-style. Also, how to set up editor-support.
TODO: We should enforce linting as part of the build.
Optional Badges
TODO: Evaluate which to keep.
