sodium-native-nodejs-mobile

NodeJS Mobile prebuilds for sodium-native

Working locally

Requirements

• Node 18
• Android NDK (CI uses version 27.2.12479018)
  • (optional) exported ANDROID_NDK_HOME environment variable

General steps

Should be clear enough to follow the reusable workflow steps but in summary:

1. Download the npm tarball package and unzip e.g.

   npm pack sodium-native@latest | xargs tar -zxvf
   

2. Navigate to unzipped directory:

   cd package
   

3. Install dependencies:

   npm install
   

4. Install patched cmake-napi:

   npm install cmake-napi@github:digidem/cmake-napi-nodejs-mobile
   

5. Install bare-make globally:

   npm install -g bare-make@latest
   

6. Generate, build and install:

   bare-make generate --platform android --arch arm64
   bare-make build
   bare-make install
   

Creating a release

1. Navigate to the Generate Prebuilds workflow
2. Manually dispatch the worflow with the version you want to build, ensuring that "Publish Release" is checked.

Contributing

We welcome contributions to this repository. If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.