janishutz/color-thief
1
0
Fork 0
mirror of https://github.com/janishutz/color-thief.git synced 2025-11-25 13:54:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add more details info on running local tests

Browse Source
This commit is contained in:
Lokesh Dhakar
2020-07-05 19:05:32 -07:00
parent 1c70277219
commit 79a480d929
1 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -3,7 +3,7 @@
Grab the color palette from an image using just Javascript.Works in the browser and in Node. 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. + `build/` - Simple script that copies and renames files into the /dist folder.
+ `cypress/` - Browsers tests. + `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. + `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-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. + `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 ### 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 dev` to start local server.
- `npm run test` - `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 ### Adding tests
- Update `cypress/test-pages/index.html` as needed or create a new test page if you need new examples. - Update `cypress/test-pages/index.html` as needed or create a new test page if you need new examples.