README.md

suite-template

A template to write data checks for the Dataproofer desktop app or any JavaScript application.

• Documentation
• Repository
• Issues

Table of Contents

• Development
  • Getting Started
  • Writing Tests
  • Building Docs

Development

Getting Started

git clone git@github.com:dataproofer/suite-template.git
cd suite-template
npm install

Writing Tests

• How To
• Helper Scripts
• Templates
  • Basic Test
  • Advanced Test

Building Docs

We use documentation.js, but have created a handy script for regenerating documentation.

npm run docs

Then open up and check your docs in DOCUMENTATION.md