napi-rs / napi-rs/website

Instructions to set up a simple unopinionated project by hand?

Open
#211 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
25
Forks
48
Avg merge
3d 22h
Merged PRs (30d)
7

Description

Hi all, thanks for creating this project!

I appreciate the napi-rs auto-installer but I am interested in setting up a napi-rs project manually (I'm weird like that). I'd like to use my own build scripts, workspace setup, omit code-gen, package manager selection, etc. I essentially want a minimal napi-rs project that only produces a .node file if possible.

In the past I have used Neon because of its unopinionated project integration but I find the napi-rs bindings to be very ergonomic and prefer to use them if possible.

I tried to deconstruct & bring over the project files produced by napi new - but the napi-rs CLI obfuscates the native module build steps (napi build) so I didn't get too far.

Are there instructions on setting up a project by hand?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the project files generated by napi new and the steps performed by napi build. Trace which files and native-module build steps are required for a minimal hand-written project, then document a setup that produces only a .node file without code generation or package-manager selection.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.