From 79a480d929b9e5cc806e1160b7460e89c3e120d3 Mon Sep 17 00:00:00 2001 From: Lokesh Dhakar Date: Sun, 5 Jul 2020 19:05:32 -0700 Subject: [PATCH] docs: Add more details info on running local tests --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7aa78d9..73a0b11 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Grab the color palette from an image using just Javascript.Works in the browser and in Node. -### View the [demo page](https://lokeshdhakar.com/projects/color-thief/) for examples, API docs, and more. +### View the [demo page](https://lokeshdhakar.com/projects/color-thief/) for examples, API docs, and more. --- @@ -13,7 +13,7 @@ Grab the color palette from an image using just Javascript.Works in the browser + `build/` - Simple script that copies and renames files into the /dist folder. + `cypress/` - Browsers tests. -+ `dist/` - Generated distribution files created by [microbundle](https://github.com/developit/microbundle) package and a couple of files copied via build script. ++ `dist/` - Generated distribution files created by [microbundle](https://github.com/developit/microbundle) package and a couple of files copied via build script. + `examples/` - CSS, JS, and Images for the index.html example page. + `src/color-thief-node.js` - Source for the Node (commonjs) compatible version of the script. + `src/color-thief.js` - Source for the browser (ES6, AMD, Global var) compatible version of the script. @@ -23,11 +23,26 @@ Grab the color palette from an image using just Javascript.Works in the browser ### Running tests -Run Cypress integration tests in Chrome browser. +There are two sets of tests: + +1. Browser tests run with [Cypress](https://www.cypress.io) +2. Node tests run with [Karma](https://karma-runner.github.io/latest/index.html) and utilizing [Mocha](https://mochajs.org/) + +To run both the browser and Node tests: - `npm run dev` to start local server. - `npm run test` +To run just the browser tests with the Cypress UI: + +- `npm run dev` to start local server +- `npm run test:browser` + +To run just the Node tests: + +- `npm run test:node` + + ### Adding tests - Update `cypress/test-pages/index.html` as needed or create a new test page if you need new examples.