https://github.com/mmomtchev/nobind-example-project

A template for a `nobind17` project using `node-gyp`
https://github.com/mmomtchev/nobind-example-project

Last synced: 8 months ago
JSON representation

A template for a `nobind17` project using `node-gyp`

• Host: GitHub
• URL: https://github.com/mmomtchev/nobind-example-project
• Owner: mmomtchev
• License: isc
• Created: 2024-07-16T12:43:14.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-11T18:12:10.000Z (8 months ago)
• Last Synced: 2025-02-11T19:26:04.807Z (8 months ago)
• Language: C++
• Size: 1.05 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Nobind example skeleton

[![Test](https://github.com/mmomtchev/nobind-example-project/actions/workflows/run.yml/badge.svg)](https://github.com/mmomtchev/nobind-example-project/actions/workflows/run.yml)

[![codecov](https://codecov.io/gh/mmomtchev/nobind-example-project/graph/badge.svg?token=ruVsKSkq1X)](https://codecov.io/gh/mmomtchev/nobind-example-project)

This is an example skeleton for a C++ project that uses Nobind using the traditional `node-gyp` build system.

It includes some non-trivial examples such as C buffers, vectors of objects and maps.

You can check [`hadron-nobind-example-project`](https://github.com/mmomtchev/hadron-nobind-example-project) for the `hadron` version.

# Try building yourself

## Build the project

```shell

git clone https://github.com/mmomtchev/nobind-example-project.git

cd nobind-example-project

npm install

```

Run the unit tests:

```shell

# Run all unit tests

npm test

```

# Code instrumentation

Build with:

```shell

npm install

npx node-gyp configure build --debug

```

Check the [CI workflow](https://github.com/mmomtchev/nobind-example-project/blob/main/.github/workflows/run.yml) for ASAN and dual-language code coverage setups.