2024-01-13 13:14:57 +01:00
|
|
|
|
|
|
|
|
## Intro
|
|
|
|
|
|
2024-01-13 13:20:59 +01:00
|
|
|
NodeJs wrapper around Waku
|
2024-01-13 13:14:57 +01:00
|
|
|
|
2024-01-13 13:20:59 +01:00
|
|
|
The Waku node binary is generated in a shape of a shared library, libwaku.so. This library is currently created from
|
|
|
|
|
the `nwaku` repository, a.k.a. "Nim Waku" (vendor dependency.)
|
2024-01-13 13:14:57 +01:00
|
|
|
|
2024-01-13 13:20:59 +01:00
|
|
|
On the other hand, the `libwaku.so` library is wrapped to NodeJs
|
|
|
|
|
by means of the `node-gyp` utility.
|
2024-01-13 13:14:57 +01:00
|
|
|
|
2024-01-13 13:20:59 +01:00
|
|
|
## Requirements
|
2024-01-13 13:14:57 +01:00
|
|
|
|
2024-01-13 13:20:59 +01:00
|
|
|
node-gyp is required to be installed in the system.
|
2024-01-13 13:14:57 +01:00
|
|
|
|
|
|
|
|
## Create a package
|
|
|
|
|
|
|
|
|
|
1. Run `npm run prepare-package`
|
|
|
|
|
2. Run `npm run build-libwaku` (step required to build the libwaku.so library)
|
|
|
|
|
3. Run `npm run build-gyp`
|
|
|
|
|
4. Run `npm run build-package`
|
|
|
|
|
|
|
|
|
|
## Publish a package
|
|
|
|
|
|
|
|
|
|
Run `npm run publish-package`
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
:information_source: See the package.json file for details about npm commands definitions.
|
|
|
|
|
|
|
|
|
|
|
