https://github.com/atishay/napi
N-API based Souvenir service for CascadiaJS 2018
https://github.com/atishay/napi
cascadiajs cplusplus imagemagick javascript n-api nan nodejs sample-code tutorial
Last synced: about 1 month ago
JSON representation
N-API based Souvenir service for CascadiaJS 2018
- Host: GitHub
- URL: https://github.com/atishay/napi
- Owner: atishay
- Created: 2018-11-15T20:11:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-15T20:41:08.000Z (over 6 years ago)
- Last Synced: 2025-05-07T06:04:00.787Z (about 1 month ago)
- Topics: cascadiajs, cplusplus, imagemagick, javascript, n-api, nan, nodejs, sample-code, tutorial
- Language: C++
- Homepage: https://n-api.herokuapp.com
- Size: 3.1 MB
- Stars: 14
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
N-API Tutorial
===========================
> Do not use this on production. This is is meant to be a tutorial and not a production API. The code has been intentionally minimized to ignore many error cases and uses synchronous APIs for simplification.
Sample code which introduces the N-API stable in Node.js since Node 10+. The native code is present in the native folder. The rest of the code is present to demonstrate a sample application. This code was prepared for the Cascadia JS conference - https://2018.cascadiajs.com/.
Here are the native pieces and the order in which they should be read:
1) **Version** Gets the ImageMagick version as a string.
2) **Info** Gets some basic information about the image from ImageMagick.
3) **Edit** Edits an image via ImageMagick to create a new version used in the demo.
There are three versions of the sample usage app:
1) **CLI** Wonderful for testing and debugging. Also used for the C++ debugger provided for VS Code.
2) **Server** Express.js based web server hosting a sample app for the **Edit** application.
3) **Electron** Sample Electron code using the **Edit** module.
No recompilation should be needed to run the electron and the node versions. Switching node versions should not need a recompilation to utilize the API. While the API is experimental in node 8 and should not be used in production, this code works for Node 8+ (with a warning in Node 8).
## Important Scripts:
* Recompile Native code
```
node-gyp rebuild
```
* Run Electron Version
```
npm run electron
```
* Run Web server
```
npm start
```
* Run command line API tests
```
npm test
```
## More resources on the N-API
* Offical Documentation - https://nodejs.github.io/node-addon-api
* Official Examples - https://github.com/nodejs/abi-stable-node-addon-examples.git (Must try)
Image from: https://pixnio.com/transportation-vehicles/cars-automobile/wet-cold-mirror-dew-rain-car#