Skip to content

arnelify/arnelify-router-node

Repository files navigation

Arnelify Logo

Arnelify Router for NodeJS C++ G++ NodeJS Bun

🚀 About

Arnelify® Router for NodeJS - is a minimalistic NodeJS (Bun) addon which is a router written in C and C++.

📋 Minimal Requirements

Important: It's strongly recommended to use in a container that has been built from the gcc v14.2.0 image.

  • CPU: Apple M1 / Intel Core i7 / AMD Ryzen 7
  • OS: Debian 11 / MacOS 15 / Windows 10 with WSL2.
  • RAM: 4 GB

📦 Installation

Installing via npm:

npm install arnelify-router

Installing via yarn:

yarn add arnelify-router

🎉 Usage

Compile library:

yarn build

Run test:

yarn test

📚 Examples

Configure the C/C++ IntelliSense plugin for VSCode (optional).

Clang_format_fallback = Google

IncludePath for VSCode (optional):

"includePath": [
  "/usr/local/include/node",
  "/opt/homebrew/Cellar/jsoncpp/1.9.6/include/json",
  "${workspaceFolder}/node_modules/node-addon-api",
  "${workspaceFolder}/src/cpp",
  "${workspaceFolder}/src"
],

You can find code examples here.

⚖️ MIT License

This software is licensed under the MIT License. The original author's name, logo, and the original name of the software must be included in all copies or substantial portions of the software.

🛠️ Contributing

Join us to help improve this software, fix bugs or implement new functionality. Active participation will help keep the software up-to-date, reliable, and aligned with the needs of its users.

⭐ Release Notes

Version 0.5.8 - NodeJS (Bun) Addon

We are excited to introduce the Arnelify Router for NodeJS (Bun) addon! Please note that this version is raw and still in active development.

Change log:

  • Minimalistic dynamic library
  • NodeJS (Bun) addon
  • FFI Support

Please use this version with caution, as it may contain bugs and unfinished features. We are actively working on improving and expanding the router's capabilities, and we welcome your feedback and suggestions.

🔗 Mentioned

About

Arnelify® Router for NodeJS - is a minimalistic NodeJS (Bun) addon which is a router written in C and C++.

Topics

Resources

License

Stars

Watchers

Forks