Before install and release
Third party libraries are installed in
/thirdparty. To successfully compile
node-opencv with no global OpenCV installation, you'll need to set
PKG_CONFIG_PATH. Run commands like so:
PKG_CONFIG_PATH=$(pwd)/thirdparty/opencv/lib/pkgconfig npm install PKG_CONFIG_PATH=$(pwd)/thirdparty/opencv/lib/pkgconfig npm run release
*.spec.js files in the
src directory will be included.
End to end tests
npm run e2e
e2e will be included.
Using istanbul code coverage tool. Run with command:
npm run coverage
You can set the reporter(s) by setting
ISTANBUL_REPORTERS environment variable (defaults to
html). The report directory can be set with
ISTANBUL_REPORT_DIR (defaults to
Making a release
To make ready for distribution installer use command:
npm run release
It will start the packaging process for operating system you are running this command on. Ready for distribution file will be outputted to
You can create Windows installer only when running on Windows, the same is true for Linux and OSX. So to generate all three installers you need all three operating systems.
All packaging actions are handled by electron-builder.
(The MIT License)
Copyright (c) 2016 Dan Schultzer, Benjamin Schultzer & the Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.